PHP CS Fixer 自定义修复器教程
1. 项目的目录结构及介绍
php-cs-fixer-custom-fixers/
├── CHANGELOG.md
├── LICENSE
├── README.md
├── bootstrap.php
├── composer.json
├── php-cs-fixer.php
├── phpunit.xml
└── src/
└── Fixers/
└── ...
└── tests/
└── ...
- CHANGELOG.md: 项目更新日志。
- LICENSE: 项目许可证。
- README.md: 项目介绍和使用说明。
- bootstrap.php: 项目启动文件。
- composer.json: Composer 配置文件。
- php-cs-fixer.php: PHP CS Fixer 配置文件。
- phpunit.xml: PHPUnit 配置文件。
- src/: 包含自定义修复器的源代码。
- tests/: 包含测试代码。
2. 项目的启动文件介绍
bootstrap.php
bootstrap.php
文件是项目的启动文件,主要用于加载自定义修复器类。在某些情况下,当 PHP CS Fixer 通过 php-cs-fixer/shim
包安装时,可能需要手动加载自定义修复器类。
require __DIR__ . '/vendor/kubawerlos/php-cs-fixer-custom-fixers/bootstrap.php';
3. 项目的配置文件介绍
php-cs-fixer.php
php-cs-fixer.php
文件是 PHP CS Fixer 的配置文件,用于注册和配置自定义修复器。
return (new PhpCsFixer\Config())
->registerCustomFixers(new PhpCsFixerCustomFixers\Fixers())
->setRules([
'@PSR2' => true,
'array_syntax' => ['syntax' => 'short'],
PhpCsFixerCustomFixers\Fixer\NoLeadingSlashInGlobalNamespaceFixer::name() => true,
PhpCsFixerCustomFixers\Fixer\PhpdocNoSuperfluousParamFixer::name() => true,
]);
- registerCustomFixers: 注册自定义修复器。
- setRules: 设置规则,包括 PSR-2 标准和自定义修复器规则。
通过以上配置,可以确保 PHP CS Fixer 使用自定义修复器进行代码格式化。