digitalrevolution / php-codesniffer-baseline
Digital Revolution PHP_Codesniffer 基线扩展
v1.1.2
2022-05-31 08:26 UTC
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-09-16 13:24:24 UTC
README
PHP_Codesniffer 基线
为了能够添加 PHP_Codesniffer 或向现有项目添加新规则,并不总是能够解决出现的新问题。由于 PHPCodesniffer 没有基线机制,并且 PR:3387 尚未接受,此包可用于为项目的当前问题设置基线。
入门
composer require --dev digitalrevolution/php-codesniffer-baseline
创建基线
通过定期使用 phpcs 并使用基线报告类编写报告来创建基线。您必须将基线写入项目的根目录,并命名为 phpcs.baseline.xml
。
php vendor/bin/phpcs src tests --report=\\DR\\CodeSnifferBaseline\\Reports\\Baseline --report-file=phpcs.baseline.xml --basepath=.
用法
像平时一样使用 phpcs。在您的项目根目录中包含 phpcs.baseline.xml
,基线扩展将自动读取配置文件并跳过基线中包含的错误。
内部原理
由于 PHP_Codesniffer 没有添加扩展的优雅且干净的方式,此包将在 composer install
或 composer update
时将一行代码注入到 /vendor/squizlabs/php_codesniffer/src/Files/File.php
。虽然这是一个脆弱的解决方案,但这只直到 PR:3387 被接受或添加了另一种基线方法。
关于我们
在 123inkt(Digital Revolution B.V. 的部分),每天有超过 50 名开发专业人士正在努力改进我们的内部 ERP 和我们的几个商店。你想加入我们吗? 我们正在寻找开发者。