NodeJS如何在npm run build流程中实现自动化文件清理修复

1. 借助npm原生生命周期钩子搭建自动触发链路 #

npm 本身内置了脚本执行顺序规则，当你执行 npm run build 时，会自动优先运行package.json中带pre前缀的同名脚本，流程跑完没有报错，才会继续执行真正的构建命令，完全不需要安装额外的第三方工具就能实现build前置的自动操作。
只需要在项目根目录的package.json的scripts字段增加对应配置即可：

{
  "scripts": {
    "prebuild": "node ./scripts/repair-upstream-file.js",
    "build": "你原本的构建命令，比如nest build / vue-cli-service build 等"
  }
}

配置完成后，不管是你本地手动执行build，还是CI流水线自动跑build，只要触发了npm run build命令，就会先执行文件修复的逻辑，不会出现漏触发的情况。

2. 编写轻量的文件处理脚本 #

在项目根目录新建scripts/repair-upstream-file.js文件，用Node内置模块实现核心逻辑，全程不需要复杂依赖：

• 用path模块定位目标文件的绝对路径，避免相对路径引发的路径找不到问题
• 用fs模块读取目标文件的原始文本内容（不要直接转成对象，避免畸形内容直接抛出解析错误中断流程）
• 按照你遇到的上游畸形格式问题，自定义对应的清理逻辑（常见的处理场景包括：去掉文件开头的BOM头、删除夹杂的不可见控制字符、替换不合法的引号格式、截断文件末尾的冗余无效内容等）
• 加一层合法性校验：确认清理后的内容是可以正常解析的合法格式，不符合的话直接抛出错误，阻断后续构建流程，避免带着坏文件打包
• 把校验通过的清理内容直接回写覆盖原文件

可以参考的基础脚本片段：

const fs = require('fs');
const path = require('path');

// 定位需要处理的上游生成文件
const targetFilePath = path.resolve(__dirname, '../config/upstream-generated-api.json');

// 读取原始文件内容
const rawFileContent = fs.readFileSync(targetFilePath, 'utf-8');

// 自定义内容清理逻辑
const cleanedContent = rawFileContent
  .replace(/^\uFEFF/, '') // 移除文件开头的BOM标识
  .replace(/[\x00-\x08\x0B\x0C\x0E-\x1F\x7F]/g, '') // 移除文本中夹杂的不可见控制字符
  .replace(/(?<!\\)'/g, '"'); // 替换未转义的单引号为JSON要求的双引号

// 校验清理后的内容是否合法
try {
  JSON.parse(cleanedContent);
} catch (err) {
  throw new Error(`文件清理后仍存在格式异常：${err.message}，已终止构建流程`);
}

// 回写覆盖原文件
fs.writeFileSync(targetFilePath, cleanedContent, 'utf-8');
console.log('上游生成文件的畸形内容清理完成');

3. 避坑提示 #

• 不要为了这个简单需求引入重型的流程自动化工具，上面这套原生实现的脚本执行耗时通常在几毫秒级别，几乎不会拖慢构建速度
• 如果你的项目存在跳过npm脚本直接执行构建命令的场景，可以把这个清理逻辑嵌入到实际的构建入口配置中做兜底，保证不管走哪个路径都能触发清理
• 清理逻辑要尽量和你遇到的实际畸形问题匹配，不要做过度的内容修改，避免把正常的文件内容改坏

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