bash脚本用jq操作package.json添加依赖报错，如何修复？

很多人用jq操作package.json时踩坑，大多是这几个原因：

核心问题排查与修复 #

1. 变量传递方式错误 #

直接把shell变量（比如包名、版本号）拼进jq表达式是最常见的语法错误根源——jq会把未加处理的变量当成自身的语法元素解析，自然会报编译错误。

正确做法是用jq的--arg参数传递字符串类型的变量：

PACKAGE="lodash"
VERSION="^4.17.21"
# 用--arg把shell变量传给jq内部变量pkg和ver
jq -i --arg pkg "$PACKAGE" --arg ver "$VERSION" '.dependencies[$pkg] = $ver' package.json

2. 未处理依赖字段不存在的情况 #

如果你的package.json里还没有dependencies字段，上面的命令会直接报错。这时候要先用//运算符给个默认空对象：

jq -i --arg pkg "$PACKAGE" --arg ver "$VERSION" '
  # 如果dependencies不存在，就创建空对象，再赋值
  .dependencies = (.dependencies // {}) | 
  .dependencies[$pkg] = $ver
' package.json

3. 文件更新的原子性问题 #

直接用> temp.json && mv...虽然能生效，但如果脚本中途中断，可能导致原文件损坏。jq自带的-i（--in-place）参数会自动处理临时文件替换，更安全：

# 直接原地修改package.json，无需手动处理临时文件
jq -i --arg pkg "$PACKAGE" --arg ver "$VERSION" '...' package.json

4. 批量更新依赖的错误写法 #

如果要一次性加多个依赖，别循环调用jq，用--argjson传递JSON对象，再用*运算符合并（会自动覆盖已有依赖的版本）：

# 定义要添加/更新的依赖JSON
DEPENDENCIES='{"react": "^18.2.0", "axios": "^1.6.1"}'
# 用--argjson把JSON字符串传给jq
jq -i --argjson deps "$DEPENDENCIES" '
  .dependencies = (.dependencies // {}) * $deps
' package.json

完整的5步测试脚本（修复版） #

#!/bin/bash

# 步骤1：创建测试用的package.json
cat > package.json << EOF
{
  "name": "test-project",
  "version": "1.0.0"
}
EOF

# 步骤2：添加第一个依赖（lodash）
PACKAGE="lodash"
VERSION="^4.17.21"
jq -i --arg pkg "$PACKAGE" --arg ver "$VERSION" '
  .dependencies = (.dependencies // {}) | 
  .dependencies[$pkg] = $ver
' package.json

# 步骤3：更新已有依赖的版本（lodash更新到^4.17.22）
VERSION="^4.17.22"
jq -i --arg pkg "$PACKAGE" --arg ver "$VERSION" '
  .dependencies[$pkg] = $ver
' package.json

# 步骤4：添加第二个依赖（axios）
PACKAGE="axios"
VERSION="^1.6.0"
jq -i --arg pkg "$PACKAGE" --arg ver "$VERSION" '
  .dependencies[$pkg] = $ver
' package.json

# 步骤5：批量添加/更新多个依赖
DEPENDENCIES='{"react": "^18.2.0", "axios": "^1.6.1"}'
jq -i --argjson deps "$DEPENDENCIES" '
  .dependencies = (.dependencies // {}) * $deps
' package.json

# 输出结果验证
cat package.json

关键注意事项 #

• 永远用--arg/--argjson传递外部变量到jq，避免字符串拼接导致的语法错误
• 利用//运算符处理字段不存在的边界情况
• 使用-i参数保证文件更新的原子性，避免损坏
• 对象合并用*运算符可以高效批量更新依赖

内容的提问来源于stack exchange，提问作者stackbiz