sirix / php-cs-fixer-config

Sirix PHP编码规范修复器配置。

维护者

详细信息

github.com/sirix777/php-cs-fixer-config

源代码

问题

安装次数: 6

依赖项: 0

建议者: 0

安全: 0

星标: 0

关注者: 1

分支: 0

公开问题: 0

1.0.1 2024-03-29 09:46 UTC

Requires

Requires (Dev)

MIT 732aa25a7de4228205cd242a487ff79643b3d020

  • Petr Romancevic <sirix.woop@inbox.lv>

This package is auto-updated.

Last update: 2024-09-29 10:51:48 UTC

README

围绕PHP-CS-Fixer包的预定义规则包装器 - 一个用于自动修复PHP编码规范问题的工具。

安装

使用Composer

推荐通过在项目中的专用composer.json文件中使用Composer来安装PHP CS Fixer，例如在tools/php-cs-fixer目录下

  1. 创建一个新的tools/php-cs-fixer目录
mkdir -p tools/php-cs-fixer
  1. 通过Composer安装
composer req --dev --working-dir=tools/php-cs-fixer sirix/php-cs-fixer-config

配置

  1. 创建一个PHP文件，命名为.php-cs-fixer.dist.php，并将其放置在项目根目录中。PHP CS Fixer会自动识别它。

  2. 文件内容应如下所示

    <?php
    
    declare(strict_types=1);
    
    use Sirix\CsFixerConfig\ConfigBuilder;
    
    return ConfigBuilder::create()
        ->inDir(__DIR__ . '/src')
        ->inDir(__DIR__ . '/test')
        ->getConfig()
    ;

或者，您可以在配置文件中添加额外的规则

        <?php
        
        declare(strict_types=1);
        
        use Sirix\CsFixerConfig\ConfigBuilder;
        
        return ConfigBuilder::create()
            ->inDir(__DIR__ . '/config')
            ->inDir(__DIR__ . '/src')
            ->inDir(__DIR__ . '/test')
            ->setRules([
                'Gordinskiy/line_length_limit' => ['max_length' => 150],
                '@PHP83Migration' => true,
            ])
            ->getConfig()
        ;
  1. 将.php-cs-fixer.cache文件放入.gitignore

用法/示例

  • 修复编码规范
$ php tools/php-cs-fixer/vendor/bin/php-cs-fixer fix -v
  • 检查编码规范而不应用修复
$ php tools/php-cs-fixer/vendor/bin/php-cs-fixer fix --dry-run
  • 检查建议的更改
$ php tools/php-cs-fixer/vendor/bin/php-cs-fixer fix --dry-run -v --diff

文档