README

• README на русском

关于

Alex Coders的PHP编码规范是一套包含两个PHP_CodeSniffer配置XML文件的集合；主要的ruleset.xml配置文件定义了基本的PHP编码规范，以及第二个ruleset-strict.xml配置文件定义了严格的PHP编码规范。

Alex Coders的PHP编码规范是确保您的代码保持清洁和一致性的必要开发工具。

要求

Alex Coders的PHP编码规范需要PHP版本5.4.0或更高版本以及PHP_CodeSniffer版本3.6.0或更高版本。

安装

开始使用Alex Coders的PHP编码规范的最简单方法是使用以下命令通过Composer进行安装

composer require "alex-the-coder/coding-standards"

或者，您可以在您的composer.json文件中包含对alex-the-coder/coding-standards的依赖项。例如

{
    "require-dev": {
        "alex-the-coder/coding-standards": "^1.0"
    }
}

然后，您可以从供应商的bin目录运行PHP_CodeSniffer，以确保正确安装了所有必要的依赖项和Alex Coders的PHP编码规范

./vendor/bin/phpcs -h

./vendor/bin/phpcbf -h

./vendor/bin/phpcs -v --standard=./vendor/alex-the-coder/coding-standards/ruleset.xml ./vendor/autoload.php

./vendor/bin/phpcs -v --standard=./vendor/alex-the-coder/coding-standards/ruleset-strict.xml ./vendor/autoload.php

入门

要检查PHP文件是否符合Alex Coders的PHP编码规范，请使用--standard命令行参数并指定文件的路径

./vendor/bin/phpcs -v --standard=./vendor/alex-the-coder/coding-standards/ruleset.xml /path/to/code/myfile.php

或者，如果您想检查整个目录，您可以指定目录的路径而不是文件

./vendor/bin/phpcs -v --standard=./vendor/alex-the-coder/coding-standards/ruleset.xml /path/to/code-directory

如果PHP_CodeSniffer发现任何编码规范错误，在运行命令后将会显示报告。

完整的用法信息和示例报告可在用法页面上找到。

自定义配置文件

为了简化使用，您可以在项目根目录中创建一个XML配置文件./.phpcs.xml，内容如下

<?xml version="1.0" encoding="UTF-8"?>
<ruleset name="PHPCS MyProjectName">
    <rule ref="./vendor/alex-the-coder/coding-standards/ruleset.xml" />
</ruleset>

然后，您可以运行简单的命令，例如

./vendor/bin/phpcs -v /path/to/code/myfile.php

或者

./vendor/bin/phpcs -v /path/to/code-directory

有关使用配置文件和注释规则集的更多信息。

自定义Sniff属性的完整列表请见此处。

文档

PHP_CodeSniffer的文档可在Github wiki上找到。

请参阅配置选项手册页面。