README

基于PSR-12、Doctrine和Slevomat编码标准的Chiron PHP编码标准

简介

此库为PHP_CodeSniffer (phpcs)提供了Chiron编码标准的规则。它受Doctrine编码标准和Slevomat编码标准的启发和构建。

开始之前，您只需要Composer。

要安装此库的最新版本，请运行以下命令

$ composer require chiron/coding-standard

PHP编码标准的最新版本至少需要PHP 7.1。

只需将默认的phpcs.xml.dist文件（可在根目录中找到）添加到您的项目中，当运行phpcs时即可使用Chiron编码标准。

如果您需要抑制一些错误，请在您的PHP代码中使用以下标签。

// phpcs:ignoreFile

// phpcs:ignore

// phpcs:disable
// phpcs:enable

此库遵循SemVer，以下为相关规则。

编码标准文档应被视为SemVer的真实来源和主要对象。

MAJOR版本将在文档中添加新规则时递增。
MINOR版本将在实现检查现有描述的规则的新sniffs时递增。
PATCH版本将在修复错误时递增 - 修复错误被视为不符合文档的任何内容 - 这甚至可能导致（暂时地）禁用现有的sniff - 或者它的部分，直到有更好的检查方法或它得到适当修复。

自动检查的实现（包括自定义sniffs和ruleset.xml文件）不受SemVer约束，可能会随时间变化以适应PHP_CodeSniffer和提供默认sniffs的变化，这些默认sniffs也由此标准使用。

此包的推荐依赖是MINOR版本（例如~1.0.0），这意味着

有关最近更改的更多信息，请参阅变更日志。

有关详细信息，请参阅贡献指南。

有关详细信息，请参阅支持信息。

MIT许可（MIT）。有关更多信息，请参阅许可文件。