0

0

如何让 Composer 在执行 require 或 update 后自动格式化 composer.json 文件?

裘德小鎮的故事

裘德小鎮的故事

发布时间:2025-12-27 15:34:02

|

603人浏览过

|

来源于php中文网

原创

Composer 本身不提供自动格式化 composer.json 的功能,但可通过配置 scripts 钩子调用 jq 或 PHP 脚本实现自动美化:jq 方案需安装 jq 并在 scripts 中定义 format-json 及 post-update-cmd/post-require-cmd;PHP 方案则用纯脚本解析并重写 JSON,适配无 jq 环境。

如何让 composer 在执行 require 或 update 后自动格式化 composer.json 文件?

Composer 本身不提供自动格式化 composer.json 的功能,但可以通过配置 scripts 钩子,在 requireupdate 后自动调用 JSON 格式化工具(如 jq 或 PHP 自带的 json_encode)来美化文件。

使用 jq 工具自动格式化(推荐)

jq 是轻量、可靠且跨平台的 JSON 处理命令行工具,适合做格式化。确保已安装:
Linux/macOS:可通过包管理器安装(如 brew install jqapt install jq);
Windows:可用 官方二进制 或通过 WSL 安装。

composer.json"scripts" 段中添加:

"scripts": {
  "format-json": "jq '.' composer.json > composer.json.tmp && mv composer.json.tmp composer.json",
  "post-update-cmd": "@format-json",
  "post-require-cmd": "@format-json"
}

这样每次运行 composer updatecomposer require xxx 后,都会自动重写并缩进 composer.json

用 PHP 脚本实现零依赖格式化

如果无法安装 jq(例如某些 CI 环境),可用纯 PHP 实现:

Rose.ai
Rose.ai

一个云数据平台,帮助用户发现、可视化数据

下载
  • 新建脚本 bin/format-composer-json.php
<?php
$json = file_get_contents('composer.json');
$data = json_decode($json, true);
if ($data === null) {
    die("Invalid JSON in composer.json\n");
}
file_put_contents('composer.json', json_encode($data, JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE) . "\n");
  • composer.json 中配置:
"scripts": {
  "format-json": "php bin/format-composer-json.php",
  "post-update-cmd": "@format-json",
  "post-require-cmd": "@format-json"
}

注意事项与常见问题

格式化不会改变内容语义,但要注意:

  • 确保 composer.json 语法合法,否则格式化会失败(jqjson_decode 会报错)
  • Git 提交时建议忽略格式化引起的空格/换行差异,可配置 .gitattributes 统一换行符
  • 若项目使用 composer.lock,格式化 composer.json 不会影响 lock 文件,但下次 update 会基于新格式重新生成
  • 避免在 post-install-cmd 中执行格式化——因为首次 install 时可能还没有 vendor/autoload.php,而某些脚本依赖它

基本上就这些。用 jq 最简单,用 PHP 脚本最稳妥,两者都能让 composer.json 始终保持整洁易读。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

162

2023.12.25

json数据格式
json数据格式

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

457

2023.08.07

json是什么
json是什么

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

549

2023.08.23

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

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

337

2023.10.13

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

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

82

2025.09.10

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

887

2023.07.31

python中的format是什么意思
python中的format是什么意思

python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

462

2024.06.27

require的用法
require的用法

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

510

2023.11.27

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

26

2026.03.13

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
第二十四期_PHP8编程
第二十四期_PHP8编程

共86课时 | 3.5万人学习

成为PHP架构师-自制PHP框架
成为PHP架构师-自制PHP框架

共28课时 | 2.6万人学习

第二十三期_PHP编程
第二十三期_PHP编程

共93课时 | 7.5万人学习

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

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