profitroom / coding-standards
此包已被弃用且不再维护。未建议替代包。
帮助多个项目维护编码规范的插件
v0.8.0
2020-02-20 14:57 UTC
Requires
- php: ^7.1
- composer-plugin-api: ^1.1
Requires (Dev)
- composer/composer: ^1.8
- friendsofphp/php-cs-fixer: ^2.15
- phpmd/phpmd: ^2.6
- phpspec/phpspec: ^5.1
README
在公司的产品中维护各种编码标准非常困难和耗时。
本插件的目的在于确保遵守采用的标准并对其进行管理。
安装
此包可以通过Composer安装
composer require --dev profitroom/coding-standards:^1.0
由于包仍处于开发阶段,您需要在您的 composer.json
中设置最小稳定性要求
{ … "minimum-stability": "dev", "prefer-stable": true }
如果您的项目中没有fixer配置(.php_cs.dist
),则安装或更新插件将为您创建它。
否则,可以使用 composer cs:configuration --force 覆盖现有的配置。
命令
插件提供了一些有用的命令
cs:configuration [options]
- 创建编码规范配置文件cs:fix [options]
- 根据编码规范修复代码
特定的规则和路径
有时默认配置不足以满足需求。可以通过指定插件提供的不同配置来定义特定于具体项目的规则和路径。
为此,在 composer.json
中使用任意额外数据,例如。
{ … "extra": { "coding-standards": "Profitroom\\CodingStandards\\Configuration\\Common" } }
并使用 cs:configuration 命令更新配置文件。
贡献
每个人都非常欢迎 贡献。