Download the PHP package bluecadet/bc_composer_ci_tools without Composer
On this page you can find all versions of the php package bluecadet/bc_composer_ci_tools. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download bluecadet/bc_composer_ci_tools
More information about bluecadet/bc_composer_ci_tools
Files in bluecadet/bc_composer_ci_tools
Package bc_composer_ci_tools
Short Description Adds functionality for ci and composer tools built by Bluecadet.
License GPL-2.0+
Informations about the package bc_composer_ci_tools
Bluecadet PHPCS CI Tools
A custom PHP_CodeSniffer report formatter plugin designed for GitHub Actions, rendering code-style violations as rich Markdown tables.
Supported PHP Versions
- PHP 7.4+
- PHP 8.0+
- PHP 8.1+
- PHP 8.2+
- PHP 8.3+
Requirements
- PHP_CodeSniffer 3.x (
squizlabs/php_codesniffer ^3.0) - Composer for installation
Installation
Install via Composer as a dev dependency:
Usage
Report Classes
This package provides three custom PHPCS report classes under Bluecadet\PHPCS\Report\:
1. MarkdownGithub (Recommended for GitHub Actions)
Formats output specifically for GitHub Actions step summaries using KaTeX math syntax for inline colors. Results render beautifully in the PR checks tab.
Output includes:
- Per-file violation tables with color-coded severity levels
- Summary table of error/warning counts across all files
- Total violation count
- Organized details section for easy scanning
2. Markdown (Generic Markdown)
Uses inline HTML color spans for generic Markdown renderers that support HTML.
3. MarkdownBase (Base Class)
Base implementation for custom report extensions. Extend this class to create custom report formats.
Local Usage (Non-GitHub Actions)
For local code style checking:
GitHub Actions Integration
See bluecadet/web-gh-actions for the ensure-composer-package action, which manages this package's installation in CI workflows.
Example workflow step:
Authors
- Pete Inge
License
GPL-2.0+