如何使用Composer管理PHP-CS-Fixer并自动修复代码风格?

admin 百科 16
推荐本地安装 PHP-CS-Fixer 为开发依赖,通过 composer require --dev friendsofphp/php-cs-fixer 添加,配置 .php-cs-fixer.php 规则集,定义 scripts 实现一键修复(cs:fix)与校验(cs:check),并结合 Git pre-commit 钩子自动处理暂存文件。

如何使用Composer管理PHP-CS-Fixer并自动修复代码风格?-第1张图片-佛山资讯网

直接用 Composer 安装 PHP-CS-Fixer 并配置为项目级开发依赖,再通过脚本或 IDE 集成实现自动修复,是最稳妥、可复现的方式。

安装 PHP-CS-Fixer 到项目中

推荐以 本地安装(而非全局)方式引入,避免版本冲突,也便于团队统一规范:

  • 运行 composer require --dev friendsofphp/php-cs-fixer,它会被添加到 require-dev
  • 安装后,可执行路径为 vendor/bin/php-cs-fixer(Linux/macOS)或 vendor\bin\php-cs-fixer.bat(Windows)
  • 检查是否可用:./vendor/bin/php-cs-fixer --version

配置规则集(.php-cs-fixer.php)

在项目根目录创建 .php-cs-fixer.php 文件,定义你想要的代码风格。不写配置则使用默认规则,但建议显式声明:

  • 常见写法是返回一个 PhpCsFixer\Config 实例,例如基于 PSR-12 或 Symfony 标准扩展
  • 示例最小配置:

    $config = new PhpCsFixer\Config();
    return $config->setRules([
        '@PSR12' => true,
        'array_syntax' => ['syntax' => 'short'],
        'no_unused_imports' => true,
    ])->setFinder(
        PhpCsFixer\Finder::create()
            ->in(['src', 'tests'])
            ->name('*.php')
            ->notName('index.php')
            ->ignoreDotFiles(true)
            ->ignoreVCS(true)
    );

    登录后复制

  • 规则名可通过 ./vendor/bin/php-cs-fixer describe [rule-name] 查看说明

一键修复与校验命令

把常用操作写进 composer.jsonscripts 段,提升执行效率和一致性:

标签: php linux js git json composer windows 工具 mac ai macos win c

发布评论 0条评论)

还木有评论哦,快来抢沙发吧~