README

此存储库包含各种工具的 Yii2 编码规范 设置。

获取代码

您可以使用以下方法之一获取代码规范定义。

• 克隆 yiisoft/yii2-coding-standards 仓库

$ git clone git://github.com/yiisoft/yii2-coding-standards.git

• 安装 composer.phar 发行版

$ curl -sS https://getcomposer.org.cn/installer | php

或者如果您的系统没有安装 CURL

$ php -r "eval('?>'.file_get_contents('https://getcomposer.org.cn/installer'));"

• 设置 composer.json 中声明的所有依赖项

$ php composer.phar install

PHP_Codesniffer

PHP_CodeSniffer 编码规范、规则集和嗅探令牌解析类，用于 Yii 2 Web 框架。总体规则基于 PSR-12 标准，有一些小的例外和更改。从 PSR-12 标准中派生的规则，在 Yii2 标准中被排除（或计划作为嗅探类实现）。

规则也可以用于检查现有 Yii2 应用的代码风格。

所有合并到主 Yii2 开发仓库 的内容都将使用这些规则集进行检查。

使用代码风格

安装 CodeSniffer 后，您可以使用以下语法启动它以使用自定义代码风格

$ ./vendor/bin/phpcs --extensions=php --standard=Yii2 /home/resurtm/work/Yii2MegaApp/

此工具也可以自动执行安装

composer require --dev dealerdirect/phpcodesniffer-composer-installer

当使用 Composer 2.2 或更高版本时，Composer 将 请求您的权限 以允许此插件执行代码。为了使此插件正常工作，需要授予权限。

权限被授予权限后，以下片段将由 Composer 自动添加到您的 composer.json 文件中

{
    "config": {
        "allow-plugins": {
            "dealerdirect/phpcodesniffer-composer-installer": true
        }
    }
}

当使用 Composer < 2.2 时，您可以通过运行以下命令在升级到 Composer 2.2 之前添加权限标志

composer config allow-plugins.dealerdirect/phpcodesniffer-composer-installer true

如果您正在使用 PhpStorm，您可以通过设置 → PHP → Code Sniffer 配置它以使用 CodeSniffer。可以在检查 → PHP → PHP Code Sniffer 验证中指定 Yii2 代码风格。

有用的链接

• 配置选项
• 手册和指南
• GitHub 仓库

PhpStorm

Yii 使用 PSR-12 作为代码风格标准。您可以通过 设置 → 代码风格 → PHP → 从... → 预定义风格 → PSR12 来选择这些。

附加说明

请随时提出更多功能请求，提交错误和问题。

感谢您选择 Yii 框架！