0

0

composer中如何配置项目的代码规范检查脚本_composer集成php-cs【详解】

尼克

尼克

发布时间:2026-01-18 10:49:02

|

390人浏览过

|

来源于php中文网

原创

Composer 本身不提供代码规范检查能力,但可通过 scripts 配置集成 php-cs-fixer:需 dev 安装、在 scripts 中定义 cs:check/cs:fix 命令、限定 src/ 和 tests/ 路径、确保配置文件位于根目录且命名正确。

composer中如何配置项目的代码规范检查脚本_composer集成php-cs【详解】

Composer 本身不提供代码规范检查能力,但可以通过 scripts 配置项集成 php-cs-fixerphpcbf工具,在 composer installcomposer run 等生命周期中自动执行检查或修复。

如何在 composer.json 中注册 php-cs-fixer 检查脚本

核心是把 php-cs-fixer 命令注册为 Composer 的自定义脚本,并确保它能被正确调用。常见错误是路径不对、未安装依赖、或未指定配置文件。

  • php-cs-fixer 必须作为 require-dev 安装:
    composer require --dev friendsofphp/php-cs-fixer
  • composer.json"scripts" 下添加命名脚本,例如:
    "scripts": {
        "cs:check": "php-cs-fixer fix --dry-run --diff",
        "cs:fix": "php-cs-fixer fix"
    }
  • 运行时使用:composer run cs:check(检查不修改)或 composer run cs:fix(自动修复)
  • 若项目根目录无 .php-cs-fixer.php.php_csphp-cs-fixer 会回退到内置规则集;建议显式配置,避免团队行为不一致

为什么 php-cs-fixer 不生效?常见路径与权限问题

脚本报错 Command "php-cs-fixer" is not defined 或直接找不到命令,通常不是 Composer 配置问题,而是二进制可执行文件未被识别。

  • 确认 vendor/bin/php-cs-fixer 文件存在且有可执行权限(Linux/macOS 下用 ls -l vendor/bin/php-cs-fixer 查看)
  • Windows 用户注意:Composer 脚本在 cmd/PowerShell 中可能无法直接调用 vendor/bin/php-cs-fixer,应改用 php vendor/bin/php-cs-fixer 形式
  • 若用 Docker 或 CI 环境,需确保 PHP CLI 版本 ≥ php-cs-fixer 所需最低版本(如 v3.20+ 要求 PHP 7.4+)
  • 某些 IDE(如 PhpStorm)的终端未加载 Composer 的 vendor/bin$PATH,导致手动运行失败,但 composer run 内部仍可工作

如何让 CS 检查只作用于 src/ 和 tests/ 目录

默认 php-cs-fixer 会扫描整个项目(包括 vendor/),必须通过参数限定范围,否则 CI 构建慢、误报多。

企奶奶
企奶奶

一款专注于企业信息查询的智能大模型,企奶奶查企业,像聊天一样简单。

下载

立即学习PHP免费学习笔记(深入)”;

  • 修改脚本命令,加入 --path-mode=intersection 和显式路径:
    "cs:check": "php-cs-fixer fix --dry-run --diff --path-mode=intersection src/ tests/"
  • 也可用 --exclude 排除不需要的目录,但不如白名单精准:--exclude=vendor,build,var
  • 若使用 .php-cs-fixer.php 配置文件,可在 Finder::create() 中直接限定路径,比命令行参数更灵活
  • 注意:--path-mode=intersection 是关键,否则传入多个路径时可能被忽略

真正容易被忽略的是配置文件的加载逻辑——php-cs-fixer 默认只读取当前工作目录下的 .php-cs-fixer.php,而 Composer 脚本执行时的工作目录就是项目根目录;但如果在子目录下运行 composer run,就可能失效。务必保证配置文件放在项目根目录,且命名准确。

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2641

2023.09.01

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

1633

2023.10.11

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

1513

2023.10.11

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

952

2023.10.23

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

1418

2023.10.23

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

1234

2023.11.03

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1447

2023.11.09

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1306

2023.11.13

高德地图升级方法汇总
高德地图升级方法汇总

本专题整合了高德地图升级相关教程,阅读专题下面的文章了解更多详细内容。

43

2026.01.16

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PHP课程
PHP课程

共137课时 | 8.8万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 7.8万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 0.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号