zendframework/zend-coding-standard

此包已被弃用且不再维护。作者建议使用 laminas/laminas-coding-standard 包。

Zend Framework 编码规范

2.0.0alpha4 2019-11-05 16:19 UTC

README

仓库于 2019-12-31 弃用

此仓库已迁移至 laminas/laminas-coding-standard

包含所有编码规范规则集的 Zend Framework 仓库。

安装

  1. 通过运行以下命令安装模块

    $ composer require --dev zendframework/zend-coding-standard
  2. 将 composer 脚本添加到您的 composer.json

    "scripts": {
      "cs-check": "phpcs",
      "cs-fix": "phpcbf"
    }
  3. 在您的仓库的基础路径上创建名为 phpcs.xml 的文件,内容如下

    <?xml version="1.0"?>
    <ruleset name="Zend Framework Coding Standard">
        <rule ref="./vendor/zendframework/zend-coding-standard/ruleset.xml"/>
    
        <!-- Paths to check -->
        <file>config</file>
        <file>src</file>
        <file>test</file>
    </ruleset>

您可以在该文件中添加或排除某些位置。有关参考,请参阅: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml

使用方法

  • 仅运行检查

    $ composer cs-check
  • 自动修复许多 CS 问题

    $ composer cs-fix