NodeJS使用readline修改文件后文件为空问题排查

核心错误：同时读写同一文件导致内容被截断 #

使用fs.createWriteStream()打开文件时，默认flags参数为'w'，该模式会直接截断（清空）目标文件内容。你的代码在创建读流后立刻创建写流，文件内容被提前清空，读流自然读取不到任何数据，line事件不会触发，最终文件保持为空状态。

方案1：先读入内存再修改写入（适合小文件） #

这种方式简单直接，适合postinstall场景下的小型配置文件或代码文件：

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

const filePath = path.join(process.cwd(), 'test.txt');

// 读取文件内容
fs.readFile(filePath, 'utf8', (err, content) => {
  if (err) throw err;
  
  // 按行处理并注释目标内容
  const modifiedContent = content.split('\n')
    .map(line => line.includes('test string') ? `// ${line}` : line)
    .join('\n');
  
  // 写入修改后的内容
  fs.writeFile(filePath, modifiedContent, 'utf8', (err) => {
    if (err) throw err;
    console.log('文件已成功修改');
  });
});

方案2：使用临时文件中转（适合大文件） #

如果处理的文件较大，避免占用过多内存，可以通过临时文件中转处理：

const fs = require('fs');
const path = require('path');
const readline = require('readline');
const { promisify } = require('util');

const rename = promisify(fs.rename);
const filePath = path.join(process.cwd(), 'test.txt');
const tempFilePath = `${filePath}.tmp`;

const readStream = fs.createReadStream(filePath);
const writeStream = fs.createWriteStream(tempFilePath);

const rl = readline.createInterface({
  input: readStream,
  terminal: false
});

rl.on('line', (line) => {
  console.log(line);
  // 注释包含目标字符串的行
  const modifiedLine = line.includes('test string') ? `// ${line}` : line;
  writeStream.write(`${modifiedLine}\n`);
});

rl.on('close', async () => {
  readStream.close();
  writeStream.close();
  
  try {
    // 用临时文件替换原文件
    await rename(tempFilePath, filePath);
    console.log('文件修改完成');
  } catch (err) {
    // 出错时清理临时文件
    fs.unlinkSync(tempFilePath);
    throw err;
  }
});

额外注意点 #

• 原代码中readline.createInterface的output参数可移除，因为你已经手动调用writeStream.write()处理输出，无需让readline自动输出到写流。
• 处理文件时建议完善错误捕获逻辑，避免postinstall脚本失败导致npm安装流程中断。

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