README

基于 PHP-CS-Fixer 的 PHP 编码规范规则集仓库

安装

目前，Composer 是唯一的支持安装工具。

$ composer require --dev facile-it/facile-coding-standard

安装时，插件会询问一些问题来自动设置您的项目。

安装程序将在您的项目根目录中添加一个 .php-cs-fixer.dist.php 文件，然后您可以手动编辑以进行更改。

CS 配置将被配置为使用 composer 自动加载源来查找您的项目文件。

仅支持 psr-0、psr-4 和 classmap 自动加载。

安装程序还会在您的 composer.json 中添加两个脚本；

"scripts": {
  "cs-check": "php-cs-fixer fix --dry-run --diff",
  "cs-fix": "php-cs-fixer fix --diff"
}

配置

安装配置应该足够使用。

如果您需要更改 CS 配置文件，我们建议不要编辑主 .php-cs-fixer.dist.php 文件。

您可以创建一个名为 .php-cs-fixer.php 的新文件，内容如下

<?php

/** @var PhpCsFixer\Config $config */
$config = require __DIR__ . '/.php-cs-fixer.dist.php';

// change your configuration...
$config->setUsingCache(false);

return $config;

用法

开始代码风格检查

$ composer cs-check

自动修复代码风格

$ composer cs-fix

PhpCsFixer 配置

请参阅 PhpCsFixer GitHub 页面。

风险规则

风险规则可能不稳定，可能会导致您的代码产生意外的行为变化。如果您想添加这些规则，您可以创建自己的 .php-cs-fixer.php 配置文件

<?php

/** @var \PhpCsFixer\Config $config */
$config = include __DIR__ . '/.php-cs-fixer.dist.php';

$rulesProvider = new Facile\CodingStandards\Rules\CompositeRulesProvider([
    new Facile\CodingStandards\Rules\DefaultRulesProvider(),
    new Facile\CodingStandards\Rules\RiskyRulesProvider(),
    new Facile\CodingStandards\Rules\ArrayRulesProvider([
        // additional rules or rules to override
    ]),
]);

$config->setRules($rulesProvider->getRules());

return $config;

生成配置

如果您在更新到新版本时遇到任何问题，可以使用以下命令重新生成默认的 .php-cs-fixer.dist.php

$ composer facile-cs-create-config

$ composer facile-cs-create-config --help

Usage:
  facile-cs-create-config [options]

Options:
      --no-dev                   Do not include autoload-dev directories
      --no-risky                 Do not include risky rules