stellarwp / coding-standards
StellarWP 代码规范嗅探规则
2.0.1
2024-01-22 15:34 UTC
Requires
- php: >=7.4
- automattic/vipwpcs: ^3.0
- slevomat/coding-standard: ^8.14.0
- squizlabs/php_codesniffer: ^3.8.0
- wp-coding-standards/wpcs: ^3.0.0
Requires (Dev)
Suggests
- dealerdirect/phpcodesniffer-composer-installer: ^0.7 || This Composer plugin will sort out the PHPCS 'installed_paths' automatically.
README
StellarWP 代码规范结合了以下规范:
- 通用(PHP_CodeSniffer 的一部分)
- PEAR(PHP_CodeSniffer 的一部分)
- PSR2(PHP_CodeSniffer 的一部分)
- Squiz(PHP_CodeSniffer 的一部分)
- Zend(PHP_CodeSniffer 的一部分)
- 自定义嗅探器(一些基于 WordPress)
重要
确保命令 phpcs
的版本为 3.4.2
或更高。为了全局安装特定版本,可以使用以下命令:
composer global require "squizlabs/php_codesniffer=3.4.2"
在 PHPStorm 中设置
您可以遵循 此指南,唯一需要替换的步骤是将 通过 Composer 安装 替换为上面的命令以安装 3.4.2 版本。
通过 phpcs.xml
文件示例用法
<?xml version="1.0"?> <ruleset name="StellarWP Coding Standards"> <rule ref="WordPress-VIP-Go"/> <rule ref="WordPress-Docs"> <exclude-pattern>*/tests/*</exclude-pattern> </rule> <rule ref="WordPress"> <exclude name="WordPress.Files.FileName"/> <exclude name="Generic.Arrays.DisallowShortArraySyntax"/> </rule> <rule ref="StellarWP"/> <!--exclude the rule for violation of direct DB calls as some have no alternative--> <rule ref="WordPress.DB.DirectDatabaseQuery"> <exclude-pattern>src/Test.php</exclude-pattern> </rule> <exclude-pattern>*/tests/_support/_generated/*</exclude-pattern> <exclude-pattern>*/vendor/*</exclude-pattern> </ruleset>