README

一个用于检查 it.rocks 编码标准的编码规范。

1. 安装

1.1 Composer

可以使用 Composer 依赖管理器安装此标准

1. 安装 Composer

2. 将编码标准作为项目依赖项安装

composer require --dev itrocks/coding-standard

1. 检查已安装的编码标准中的 "ITRocks"

vendor/bin/phpcs -i

应显示 ITRocks 编码标准，以及其他标准

1. 如果需要，将编码标准添加到 PHP_CodeSniffer 安装路径

vendor/bin/phpcs --config-set installed_paths `realpath vendor/itrocks/coding-standard/ITRocks`

1. 完成！

vendor/bin/phpcs --standard=ITRocks ./

1.2 独立安装

1. 检出此仓库

git clone https://git.crafter.fr/itrocks/coding-standard

1. 安装依赖项

cd coding-standard
composer install

1. 检查已安装的编码标准中的 "ITRocks"

vendor/bin/phpcs -i

1. 如果需要，将编码标准添加到 PHP_CodeSniffer 安装路径

vendor/bin/phpcs --config-set installed_paths `realpath ITRocks`

1. 使用方法

vendor/bin/phpcs --standard=ITRocks /home/vendor/project

您可以使用此工具本身检查其是否遵守 ITRocks 标准

vendor/bin/phpcs --standard=ITRocks --extensions=php $CI_PROJECT_DIR/ITRocks

2. 运行单元测试

从命令行

只需运行

vendor/bin/phpunit

从 PHPStorm，本地安装了 PHP

右键单击 "phpunit.xml.dist" 并选择 "运行 phpunit.xml.dist"。

此操作仅适用于将 coding-standard 安装为项目依赖项。如果要在独立模式下运行测试，您必须将此文件路径更改为 phpunit.xml.dist 文件中的路径

• 对于依赖项：bootstrap="../../../vendor/squizlabs/php_codesniffer/tests/bootstrap.php"
• 对于独立安装：bootstrap="vendor/squizlabs/php_codesniffer/tests/bootstrap.php"

3. PhpStorm 集成

在您的磁盘上克隆此项目后，您可以直接在 PhpStorm 中集成编码标准规则。

进入 PhpStorm 设置 语言 & 框架 > PHP > Code Sniffer 以配置 phpcs 可执行文件路径

单击“应用”按钮。

现在，转到：编辑 > 检查 > PHP > PHP Code Sniffer 验证，勾选复选框并按以下方式配置

就是这样！

要检查文件/目录，只需在项目窗口中右键单击它，选择“检查代码...”，然后确定。

4. PhpStorm 自动修复

1. 转到设置 -> 工具 -> 外部工具
2. 配置以下内容

• 名称：应用编码标准
• 程序：/home/vendor/project/vendor/bin/phpcbf（使用项目路径）
• 参数：-vvv --standard=ITRocks --extensions=php,fixed.inc $FilePath$
• 项目目录：$ProjectFileDir$

1. 转到设置 -> 键盘映射 -> 外部工具 -> 编码标准

• 右键单击 -> 添加键盘快捷键
• 添加：Ctrl+<

现在您可以使用 Ctrl+< 键盘组合或菜单工具 -> 外部工具 -> 应用编码标准来自动修复 PHP 文件