sun-asterisk / coding-standard
Sun* 研发 PHP 编码规范
v0.2.5
2022-07-22 03:14 UTC
Requires
- php: >=7.1
- dealerdirect/phpcodesniffer-composer-installer: ^0.7.2
- slevomat/coding-standard: ^6.4
- squizlabs/php_codesniffer: ^3.7
README
Sun* 为 PHP_CodeSniffer 定制的编码规范。
安装
使用 composer
composer require --dev sun-asterisk/coding-standard
使用方法
将 SunAsterisk
标准添加到项目的 phpcs.xml
<?xml version="1.0" encoding="UTF-8"?> <ruleset name="YourProject" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <rule ref="SunAsterisk"/> </ruleset>
或者直接在命令行使用
vendor/bin/phpcs --standard=SunAsterisk <file or directory to check>
Laravel
针对 Laravel 项目的 SunAsteriskLaravel
标准进行了扩展。您可以使用以下方式:
<?xml version="1.0" encoding="UTF-8"?> <ruleset name="YourProject" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <file>app</file> <file>config</file> <file>database</file> <file>resources</file> <file>routes</file> <file>tests</file> <exclude-pattern>vendor/</exclude-pattern> <rule ref="SunAsteriskLaravel"/> </ruleset>
有关更详细的用法,请参阅 phpcs 文档。同时,有关某些嗅探器的详细信息,请参阅 slevomat/coding-standard。