youdot / coding-standard
适用于所有 Youdot PHP 项目的编码规范,基于 Doctrine PHPCS 规则集,并增加了额外检查。
3.1.0
2020-12-09 09:41 UTC
Requires
- doctrine/coding-standard: ^8.0
- phpstan/phpdoc-parser: >=0.4.4
Requires (Dev)
- phpstan/phpstan: ^0.12.59
- phpunit/phpunit: ^9.5.0
README
你dots 编码规范是一套应用于所有 Youdot 项目的 PHP_CodeSniffer 规则。你dots 编码规范在 Doctrine 编码规范 的基础上进行了大量修改。
安装
composer require youdot/coding-standard --dev
使用方法
<!-- Include full Youdot Coding Standard --> <rule ref="Youdot"/> <!-- Or include full Youdot Coding Standard for Symfony--> <rule ref="YoudotSymfony"/>
额外 Sniffs
- 蛇形变量
- 修饰符字母撇号字符
- 通过 Psalm 实现不可变类
禁用它们
<rule ref="Youdot"> <exclude name="Youdot.NamingConventions.ValidVariableName"/> <exclude name="Youdot.Strings.ModifierLetterApostrophe"/> </rule>
如果你使用 Psalm,你可以启用
<rule ref="YoudotAdditional.Classes.PsalmImmutable"/>