README

PHP自动代码风格修复器

此包通过 composer 允许使用一组预定义规则自动运行PHP代码风格的修复器，这些规则被用作格式化原始php代码的基本规则。

安装

使用以下命令通过composer安装此包

$ composer require avto-dev/php-cs-fixer "^1.3"

需要安装composer（如何安装composer）。

使用

在您的应用程序目录中，请在终端中执行以下操作

$ php ./vendor/bin/cs-fix

您可以选择传递启动参数。传递 --config 参数时，该包生成的所有参数都将被忽略，并将使用您提供的参数启动。

如果您需要可选地重写fixer的规则参数，则在应用程序根目录中创建一个名为 .cs_rules.php 的文件，返回一个包含规则的关联数组（有关规则的更多详细信息，请参阅此链接）。如果有此文件，其内容将与包配置合并，可选地覆盖必要的规则。它应该具有以下形式

<?php

/**
 * CS Fixer Rules.
 *
 * @see https://github.com/FriendsOfPHP/PHP-CS-Fixer
 * @see https://mlocati.github.io/php-cs-fixer-configurator/
 */
return [
    '@PSR2'                  => true,
    '@PHP71Migration'        => true,
    'binary_operator_spaces' => [
        'operators' => [
            '='  => 'align_single_space',
            '=>' => 'align_single_space',
        ],
    ],
    'blank_line_after_namespace'         => true,
    'blank_line_after_opening_tag'       => true,
];

同样，您可以在根目录中放置一个名为 .cs_excludes.php 的文件，其中包含在处理时应排除的目录路径，例如

<?php

/**
 * Excludes directories names.
 *
 * NOTE: excludes will works only for directories.
 */
return [
    'bootstrap',
    'storage',
    'vendor',
    'public',
    'resources',
];

要重写缓存文件路径，请设置环境变量 PHP_CS_FIX_CACHE_FILE_PATH，其值为您需要的路径。例如

$ PHP_CS_FIX_CACHE_FILE_PATH=./.new.cache ./cs-fix

关于包的更多详细信息 - 查看源代码，Luke。

变更日志

变更日志可在此处找到。

支持

如果您发现任何包错误，请在当前存储库中提交问题。

许可协议

这是开源软件，受MIT许可证许可。