README

🚧

这是一个针对 PHP CodeSniffer 的外部规则集，旨在供嗅探开发者使用。

安装
- 基于 Composer 项目的安装
- 全局安装 Composer
PHPCSDev 规则集用于嗅探仓库
- 从命令行使用规则集
- 从基于项目的规则集中使用规则集
贡献
许可证

安装

基于 Composer 项目的安装

从您的项目的根目录运行以下命令

composer config allow-plugins.dealerdirect/phpcodesniffer-composer-installer true
composer require --dev phpcsstandards/phpcsdevcs:"^1.0"

全局安装 Composer

如果您在多个不同的嗅探仓库中工作，您可能希望全局安装此工具集

composer global config allow-plugins.dealerdirect/phpcodesniffer-composer-installer true
composer global require --dev phpcsstandards/phpcsdevcs:"^1.0"

Composer 将自动安装依赖项，并使用 Composer PHPCS 插件将 PHPCSDev 和其他外部标准注册到 PHP_CodeSniffer 中。

PHPCSDev 规则集用于嗅探仓库

一旦此项目安装完成，您在运行 phpcs -i 时将看到一个新的 PHPCSDev 规则集在已安装标准的列表中。

重要：此规则集当前要求 PHP_CodeSniffer >= 3.6.2+。

由于嗅探开发者将主要使用 PHP_CodeSniffer 的最新版本，这不应该引起任何问题。

类似地，在自动 CI 运行中的 CS 检查通常应运行在高版本的 PHPCS 上以获得最佳结果。

PHPCSDev 标准可以由嗅探开发者用于检查他们的嗅探仓库代码的代码风格。

通常，嗅探仓库将使用它们添加的标准中的代码风格。然而，并非所有的嗅探仓库都真正关注代码风格。

因此，对于那些需要保持代码库一致性的基本标准的仓库，这个标准应该是有用的。

标准将检查以下内容

符合 PSR-12，但有少数例外。
使用 camelCase 变量和函数名称。
使用规范化的数组。
所有文件、类、函数和属性都使用文档块进行文档化，并包含所需的最少信息。
一些任意额外的代码风格和 QA 检查。
PHP跨版本兼容性，同时允许PHPCS自身填充的标记。注意：为了获得最佳结果，项目的自定义规则集应设置testVersion配置变量。默认情况下不会这样做，因为当前配置变量很难被覆盖。

规则集可以像其他规则集一样使用，并且可以从自定义项目规则集中添加或覆盖特定的嗅探器和设置。

从命令行使用规则集

phpcs . --standard=PHPCSDev

从基于项目的规则集中使用规则集

将以下行添加到您项目的phpcs.xml.dist文件中

<rule ref="PHPCSDev"/>

贡献

欢迎为此项目做出贡献。只需克隆仓库，从main分支，进行更改，提交它们，然后提交一个拉取请求。

如果您不确定您提出的更改是否会受到欢迎，首先打开一个问题来讨论您的提案。

许可证

此代码在GNU Lesser General Public License (LGPLv3)下发布。有关更多信息，请访问http://www.gnu.org/copyleft/lesser.html

phpcsstandards / phpcsdevcs

维护者

详细信息