maxictbv / coding-standard
MaxICT 编码标准
1.0
2023-05-26 12:28 UTC
Requires
- php: ^8.0
- dealerdirect/phpcodesniffer-composer-installer: ^1.0
- doctrine/coding-standard: ^12.0
Requires (Dev)
- roave/security-advisories: dev-latest
README
这是一个用于MaxICT PHP代码库的PHP_CodeSniffer编码标准。
安装
要安装,运行
composer require --dev maxictbv/coding-standard
将phpcs.xml.dist
文件复制到项目根目录。
渐进式应用
大多数遗留代码库一开始可能无法很好地与完整的编码标准兼容。例如,引入严格的数据类型可能会导致严重问题。为了避免这些问题,可以使用以下方法。这有点繁琐,因为不幸的是,Codesniffer只能排除规则(黑名单),而不能白名单
- 将
phpcs.xml.dist
文件复制到项目根目录。 - 为每个嗅探器添加一个排除。
- 逐个移除排除项,直到达到可接受的集合。
- 当代码库随时间改进时,不时重新评估是否可以启用更多规则,并在必要时这样做。