如何在Gulp中同时更新package.json和package-lock.json文件

问题原因 #

你的代码存在4个核心错误导致修改未生效：

1. 异步任务处理逻辑错误：Gulp的流操作是异步执行的，你在调用modifyValue之后立刻执行cb()标记任务结束，此时文件读写、修改的流还没执行完成，Gulp就直接终止了进程，自然不会写入修改后的文件。
2. 变量未定义：代码中直接使用了patch变量，但没有定义读取原有patch值的逻辑，运行时会触发变量未定义报错，导致后续修改逻辑失效。
3. 文件结构不匹配：标准package.json和package-lock.json的字段结构完全不同，如果你是要修改标准版本号，版本号是存放在version字段的字符串（格式为x.y.z），并不是根路径下单独的patch字段；如果你的项目确实自定义了patch根字段，也要确认package-lock.json中存在对应字段，否则修改无效。
4. 控制台输出JSON的原因：大概率是你使用的Gulp JSON处理插件开启了默认日志输出，或是流处理过程中异常输出到了标准输出流。

修复方案 #

情况1：你确实需要修改两个文件根路径下的自定义patch字段

const { src, dest } = require('gulp');
const json = require('gulp-json-editor');
// 读取本地package.json的原有内容
const pkg = require('./package.json');

function modifyValue(key, value) {
    // 返回流，让Gulp监听流的执行状态，执行完成后再标记任务结束
    return src('./package*.json')
      .pipe(json({
        key: key,
        value: value
      }))
      .pipe(dest('./'));
}

function incrementPatch() {
    const newValue = Number(pkg.patch) + 1;
    return modifyValue('patch', newValue);
}

exports.incrementPatch = incrementPatch

情况2：你需要修改标准版本号的patch位

const { src, dest } = require('gulp');
const json = require('gulp-json-editor');

function incrementPatch() {
    return src('./package*.json')
      .pipe(json(function (json) {
        // 拆分x.y.z格式的版本号，累加patch位
        const [major, minor, patch] = json.version.split('.').map(Number);
        json.version = `${major}.${minor}.${patch + 1}`;
        return json;
      }))
      .pipe(dest('./'));
}

exports.incrementPatch = incrementPatch

注意事项 #

• 请确认你安装的JSON处理插件是gulp-json-editor，不同Gulp JSON插件的传参格式差异很大，如果使用其他插件请对应调整配置。
• 如果不需要修改package-lock.json，可以把路径匹配规则缩小为./package.json，避免不必要的文件修改。

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