README

这是一个为 Alley Interactive 定制的 PHPCS 规则集。

安装

要在项目中使用此标准，请将其声明为依赖项。

composer require --dev alleyinteractive/alley-coding-standards

这将安装最新兼容版本的 PHPCS、WPCS 和 VIPCS 到您的 vendor 目录，以便在本地运行 sniffs。

您还可以手动将其添加到项目的 composer.json 文件中，作为 require 属性的一部分

"require": {
	"alleyinteractive/alley-coding-standards": "^2.0"
}

使用方法

要从命令行直接使用 phpcs 使用此标准，请使用以下命令

vendor/bin/phpcs --standard=Alley-Interactive .

或者，您可以将此设置为 composer 脚本，这将自动引用正确的 phpcs 版本和依赖标准。

"scripts": {
	"phpcs" : "phpcs --standard=Alley-Interactive ."
}

然后使用以下命令

composer run phpcs

您还可以向 composer phpcs 脚本传递参数，使用 -- 操作符，如下所示

composer run phpcs -- --report=summary

扩展规则集

您可以通过在项目中创建自己的 phpcs.xml 文件来扩展或自定义这些规则，以创建一个自定义规则集，该文件引用这些规则

<?xml version="1.0"?>
<ruleset>
  <description>Example project ruleset</description>

  <!-- Include Alley Rules -->
  <rule ref="Alley-Interactive" />

  <!-- Project customizations go here -->
</ruleset>

测试

当为此项目做出贡献时，规则集的修改应与 tests 目录中的相应测试相对应。大部分情况下，这表现为在 tests/fixtures/pass 中通过测试和在 tests/fixtures/fail 中失败测试。您可以使用 composer phpunit 运行测试。如果您想对测试用例运行 PHPCS，可以运行 composer phpcs:fixtures 以确保通过/失败与您的预期相符。对于 tests/fixtures/fail 中的失败用例，我们建议保持文件较小且专注于特定 sniffs。

变更日志

有关最近更改的更多信息，请参阅 CHANGELOG。

致谢

此项目由 Alley Interactive 积极维护。喜欢你所看到的？加入我们工作。

许可证

GNU 通用公共许可证 (GPL)。有关更多信息，请参阅许可证文件。

alleyinteractive / alley-coding-standards

维护者

详细信息

README

安装

使用方法

扩展规则集

测试

变更日志

致谢

许可证