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 配置问题,而是二进制可执行文件未被识别。

VIVA
VIVA

一个免费的AI创意视觉设计平台

下载
  • 确认 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,就可能失效。务必保证配置文件放在项目根目录,且命名准确。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
composer是什么插件
composer是什么插件

Composer是一个PHP的依赖管理工具,它可以帮助开发者在PHP项目中管理和安装依赖的库文件。Composer通过一个中央化的存储库来管理所有的依赖库文件,这个存储库包含了各种可用的依赖库的信息和版本信息。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

161

2023.12.25

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

455

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

546

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

334

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

82

2025.09.10

phpstorm怎么导出项目
phpstorm怎么导出项目

phpstorm提供导出项目功能,步骤如下:打开phpstorm项目转到“项目”菜单选择“导出项目”选择导出格式指定导出位置选择导出范围勾选“包括依赖项”框(可选)单击“导出”完成导出。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

387

2024.04.08

phpStorm怎么运行
phpStorm怎么运行

本专题整合了phpstorm运行教程,阅读专题下面的文章了解更多相关内容。

89

2025.09.18

phpstorm开发环境搭建教程
phpstorm开发环境搭建教程

本专题整合了phpstorm开发环境搭建和运行项目教程,阅读专题下面的文章了解更多详细教程。

78

2025.09.18

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

3

2026.03.11

热门下载

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

精品课程

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

共137课时 | 13.3万人学习

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

共6课时 | 11.3万人学习

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

共13课时 | 1.0万人学习

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

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