digitalrevolution / php-codesniffer-baseline
Digital Revolution PHP_Codesniffer baseline extension
Installs: 303 419
Dependents: 1
Suggesters: 0
Security: 0
Stars: 14
Watchers: 1
Forks: 4
Open Issues: 3
Type:composer-plugin
Requires
- php: >=7.4
- composer-plugin-api: ^1.0 || ^2.0
- squizlabs/php_codesniffer: ^3.6
Requires (Dev)
- composer/composer: ^2.0
- micheh/phpcs-gitlab: ^1.1
- mikey179/vfsstream: 1.6.10
- phpmd/phpmd: @stable
- phpstan/extension-installer: ^1.1
- phpstan/phpstan: ^1.4
- phpstan/phpstan-phpunit: ^1.0
- phpstan/phpstan-strict-rules: ^1.1
- phpunit/phpunit: ^9.5
- roave/security-advisories: dev-latest
This package is auto-updated.
Last update: 2024-11-11 09:41:42 UTC
README
PHP_Codesniffer baseline
To be able to add PHP_Codesniffer or adding new rules to an existing project, it is not always possible to solve all the new issues that appear. As PHPCodesniffer doesn't have a baseline mechanism and while PR:3387 is not accepted yet, this package can be used to baseline your projects current issues.
Getting Started
composer require --dev digitalrevolution/php-codesniffer-baseline
Create baseline
Create the baseline by using phpcs regularly and writing the report with the Baseline report class. You must write the baseline
to the root of the project and name it phpcs.baseline.xml
.
php vendor/bin/phpcs src tests --report=\\DR\\CodeSnifferBaseline\\Reports\\Baseline --report-file=phpcs.baseline.xml --basepath=.
Usage
Use phpcs like you normally would. With phpcs.baseline.xml
in the root of your project, the baseline extension will automatically read the config
file and skip errors that are contained within the baseline.
Under the hood
As PHP_Codesniffer doesn't have a nice and clean way to add an extension, this package will inject a single line of code
into the /vendor/squizlabs/php_codesniffer/src/Files/File.php
upon composer install
or composer update
. While this
is a fragile solution, this is only until PR:3387 is accepted
or another baseline method has been added.
About us
At 123inkt (Part of Digital Revolution B.V.), every day more than 50 development professionals are working on improving our internal ERP and our several shops. Do you want to join us? We are looking for developers.