automattic / vipwpcs
PHP_CodeSniffer 规则(嗅探器)以强制执行 WordPress VIP 最小编码约定
3.0.1
2024-05-10 20:31 UTC
Requires
- php: >=5.4
- phpcsstandards/phpcsextra: ^1.2.1
- phpcsstandards/phpcsutils: ^1.0.11
- sirbrillig/phpcs-variable-analysis: ^2.11.18
- squizlabs/php_codesniffer: ^3.9.2
- wp-coding-standards/wpcs: ^3.1.0
Requires (Dev)
- php-parallel-lint/php-console-highlighter: ^1.0.0
- php-parallel-lint/php-parallel-lint: ^1.3.2
- phpcompatibility/php-compatibility: ^9
- phpcsstandards/phpcsdevtools: ^1.0
- phpunit/phpunit: ^4 || ^5 || ^6 || ^7 || ^8 || ^9
- dev-develop
- 3.0.1
- 3.0.0
- 2.3.4
- 2.3.3
- 2.3.2
- 2.3.1
- 2.3.0
- 2.2.0
- 2.1.0
- 2.0.0
- 1.0.0
- 0.4.0
- 0.3.1
- 0.3.0
- 0.2.5
- 0.2.4
- 0.2.3
- 0.2.2
- 0.2.1
- dev-feature/phpstan-fix
- dev-rm/WordPress.Security.EscapeOutput.ExceptionNotEscaped
- dev-main
- dev-release/3.0.1
- dev-feature/soft-deprecate-sniffs-for-phpcs-4.0
- dev-options_race_sniff
- dev-rebecca/fix_113
- dev-rebecca/adjust_lowcacheexpirysniff
This package is auto-updated.
Last update: 2024-08-27 15:59:22 UTC
README
此项目包含用于验证为 WordPress VIP 开发的代码的 PHP_CodeSniffer (PHPCS) 嗅探器和规则集。
此项目包含两个规则集
WordPressVIPMinimum
- 用于与(较旧)WordPress.com VIP 平台上的项目一起使用。WordPress-VIP-Go
- 用于与(较新)VIP Go 平台上的项目一起使用。
这些规则集仅包含根据 WordPress VIP 文档认为是 错误 和 警告 的规则。
规则集使用来自 WordPress 编码标准 (WPCS) 项目和 VariableAnalysis 标准的规则。
了解为什么违规被标记为错误与警告,以及这些级别的含义。
最小要求
安装
Composer 将安装 PHPCS、PHPCSUtils、PHPCSExtra、WPCS 和 VariableAnalysis 的最新兼容版本,并将外部标准注册到 PHP_CodeSniffer。
有关安装 PHP_CodeSniffer 的详细信息,请参阅 WordPress VIP 的安装说明。
从 VIPCS 版本 2.3.0 开始,不再需要 require
PHP_CodeSniffer Standards Composer Installer 插件,因为它是 VIPCS 的要求。尽管如此,当使用 Composer 2.2 或更高版本时,仍然需要授权运行该插件。
Composer 项目级安装
要安装 VIP 编码标准,请在项目的根目录中运行以下命令
composer config allow-plugins.dealerdirect/phpcodesniffer-composer-installer true
composer require --dev automattic/vipwpcs
Composer 全局安装
或者,它可以标准地全局安装,以便跨多个项目使用
composer global config allow-plugins.dealerdirect/phpcodesniffer-composer-installer true
composer global require --dev automattic/vipwpcs
贡献
请参阅 CONTRIBUTING.md。
许可
在 GPL-2.0-or-later 许可下。