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 实现:

Explainpaper
Explainpaper

阅读学术论文的更好方法,你的学术论文阅读助手。

下载
  • 新建脚本 bin/format-composer-json.php

  • 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 始终保持整洁易读。

相关专题

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

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

1761

2023.09.01

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

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

1179

2023.10.11

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

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

1076

2023.10.11

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

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

948

2023.10.23

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

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

1396

2023.10.23

html怎么上传
html怎么上传

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

1228

2023.11.03

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

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

1439

2023.11.09

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

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

1303

2023.11.13

ip地址修改教程大全
ip地址修改教程大全

本专题整合了ip地址修改教程大全,阅读下面的文章自行寻找合适的解决教程。

27

2025.12.26

热门下载

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

精品课程

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

共86课时 | 3.4万人学习

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

共28课时 | 2.3万人学习

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

共93课时 | 6.6万人学习

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

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