0

0

如何使用composer-normalize插件保持composer.json文件格式一致?(团队协作)

穿越時空

穿越時空

发布时间:2026-01-11 14:00:51

|

989人浏览过

|

来源于php中文网

原创

composer-normalize 插件可自动统一 composer.json 的格式、排序与结构,支持本地安装、一键标准化、Git 钩子集成及自定义配置,提升团队协作效率。

如何使用composer-normalize插件保持composer.json文件格式一致?(团队协作)

使用 composer-normalize 插件能自动统一 composer.json 的格式、排序和结构,特别适合团队协作中避免因手动编辑导致的格式差异和 Git 冗余变更。

安装 composer-normalize

推荐以项目本地方式安装,确保所有成员使用相同版本:

  • 运行 composer require --dev johnpbloch/composer-normalize
  • 安装后会自动注册为 Composer 插件,无需额外启用
  • 也可全局安装(composer global require johnpbloch/composer-normalize),但不建议——版本易不一致

基础用法:一键标准化

在项目根目录执行以下命令即可格式化当前 composer.json

  • composer normalize —— 格式化并保存(默认行为)
  • composer normalize --dry-run —— 预览改动,不写入文件(适合 CI 或提交前检查)
  • composer normalize --diff —— 输出具体 JSON 差异(类似 git diff)

它会自动处理字段顺序(如 nametypedescription 等按规范排列)、缩进、空行、键名大小写(如统一为 autoload 而非 autoloading),并校验语法合法性。

集成到团队工作流

让标准化成为习惯,而不是事后补救:

Seede AI
Seede AI

AI 驱动的设计工具

下载
  • composer.jsonscripts 中添加:
    "scripts": { "normalize": "composer normalize" }
    成员可直接运行 composer run normalize
  • 配合 Git hooks(如 pre-commit)自动执行:
    使用 composer normalize --dry-run 检查,失败则阻止提交
  • CI 流水线中加入:
    composer normalize --dry-run && echo "✅ composer.json is normalized"
    不通过即报错,强制格式合规

自定义规则(按需调整)

默认规则已覆盖大多数场景,如需微调,可在项目根目录添加 composer-normalize.json

  • 控制字段顺序:"sort-keys": true(默认开启)
  • 跳过特定字段排序:"skip-sorting": ["scripts"]
  • 设置缩进空格数:"indent-size": 2
  • 禁用自动添加缺失字段(如 license):"add-missing": false

配置项不多,够用为主;团队共用一份配置文件,放在 Git 中同步即可。

基本上就这些。不需要记住复杂命令,也不用争论“该不该换行”“autoload 应该放第几行”,跑一次 composer normalize,大家的 composer.json 就自然对齐了。

相关专题

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

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

148

2023.12.25

json数据格式
json数据格式

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

408

2023.08.07

json是什么
json是什么

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

532

2023.08.23

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

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

309

2023.10.13

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

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

74

2025.09.10

sort排序函数用法
sort排序函数用法

sort排序函数的用法:1、对列表进行排序,默认情况下,sort函数按升序排序,因此最终输出的结果是按从小到大的顺序排列的;2、对元组进行排序,默认情况下,sort函数按元素的大小进行排序,因此最终输出的结果是按从小到大的顺序排列的;3、对字典进行排序,由于字典是无序的,因此排序后的结果仍然是原来的字典,使用一个lambda表达式作为key参数的值,用于指定排序的依据。

384

2023.09.04

require的用法
require的用法

require的用法有引入模块、导入类或方法、执行特定任务。想了解更多require的相关内容,可以阅读本专题下面的文章。

464

2023.11.27

自建git服务器
自建git服务器

git服务器是目前流行的分布式版本控制系统之一,可以让多人协同开发同一个项目。本专题为大家提供自建git服务器相关的各种文章、以及下载和课程。

637

2023.07.05

c++主流开发框架汇总
c++主流开发框架汇总

本专题整合了c++开发框架推荐,阅读专题下面的文章了解更多详细内容。

78

2026.01.09

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 8.2万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.1万人学习

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

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