automattic/vipwpcs

PHP_CodeSniffer 规则(嗅探器)以强制执行 WordPress VIP 最小编码约定

安装量: 5,918,418

依赖项: 115

建议者: 0

安全: 0

星级: 235

关注者: 12

分支: 40

开放问题: 110

类型:phpcodesniffer-standard


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 许可下。