composer-normalize 是一个 PHP 项目格式化工具,1. 统一 composer.json 缩进为 4 空格;2. 按标准顺序排列键;3. 清理多余符号;4. 验证语法并提示缺失字段;5. 支持项目内安装、CI 检查与 Git 钩子集成,确保团队协作中配置文件一致,提升可读性与版本控制效率。

在团队协作开发中,composer.json 文件是 PHP 项目依赖管理的核心。不同开发者可能因编辑器格式化规则、手动修改习惯不一,导致该文件结构混乱、缩进不一致、键顺序错乱等问题。这不仅影响可读性,还容易在 Git 提交中产生无意义的差异。为解决这一问题,composer-normalize 成为了规范配置文件格式的实用工具。
什么是 composer-normalize?
composer-normalize 是一个由 localheinz 开发并维护的 Composer 插件,它能自动分析并标准化 composer.json(以及可选的 composer.lock)文件的格式。它会执行以下操作:
- 统一 JSON 缩进为 4 个空格
- 确保属性按推荐顺序排列(如 name、description、type、license 等)
- 移除多余的空白行或逗号
- 验证 JSON 语法正确性
- 添加缺失的推荐字段提示(如 license)
最终生成一个结构清晰、格式统一的配置文件,便于团队阅读和版本控制追踪。
安装与使用方式
你可以在项目级别或全局安装该工具。推荐在项目中作为开发依赖引入,以确保所有协作者使用相同版本。
运行以下命令进行安装:
composer require --dev localheinz/composer-normalize
安装完成后,即可使用 normalize 命令:
composer normalize
执行后,工具会自动检测当前目录下的 composer.json 并进行格式化。如果文件已有不一致,它会直接修改保存。
标签: php js git json composer 工具 配置文件 排列
还木有评论哦,快来抢沙发吧~