javascript - 用nodejs替换文件中的字符串

Question

我使用md5 grunt 任务来生成 MD5 文件名。现在我想用任务回调中的新文件名重命名 HTML 文件中的源。我想知道最简单的方法是什么。

score 384 · Accepted Answer

您可以使用简单的正则表达式：

var result = fileAsString.replace(/string to be replaced/g, 'replacement');

所以...

var fs = require('fs')
fs.readFile(someFile, 'utf8', function (err,data) {
  if (err) {
    return console.log(err);
  }
  var result = data.replace(/string to be replaced/g, 'replacement');

  fs.writeFile(someFile, result, 'utf8', function (err) {
     if (err) return console.log(err);
  });
});

score 105 · Accepted Answer

由于 replace 对我不起作用，我创建了一个简单的 npm 包replace-in-file来快速替换一个或多个文件中的文本。它部分基于@asgoth 的回答。

编辑（2016 年 10 月 3 日）：该软件包现在支持 Promise 和 glob，并且使用说明已更新以反映这一点。

编辑（2018 年 3 月 16 日）：该软件包现在每月的下载量已超过 10 万次，并且已通过附加功能和 CLI 工具进行了扩展。

安装：

npm install replace-in-file

需要模块

const replace = require('replace-in-file');

指定替换选项

const options = {

  //Single file
  files: 'path/to/file',

  //Multiple files
  files: [
    'path/to/file',
    'path/to/other/file',
  ],

  //Glob(s) 
  files: [
    'path/to/files/*.html',
    'another/**/*.path',
  ],

  //Replacement to make (string or regex) 
  from: /Find me/g,
  to: 'Replacement',
};

用 Promise 进行异步替换：

replace(options)
  .then(changedFiles => {
    console.log('Modified files:', changedFiles.join(', '));
  })
  .catch(error => {
    console.error('Error occurred:', error);
  });

带回调的异步替换：

replace(options, (error, changedFiles) => {
  if (error) {
    return console.error('Error occurred:', error);
  }
  console.log('Modified files:', changedFiles.join(', '));
});

同步替换：

try {
  let changedFiles = replace.sync(options);
  console.log('Modified files:', changedFiles.join(', '));
}
catch (error) {
  console.error('Error occurred:', error);
}

score 42 · Accepted Answer

也许“替换”模块（www.npmjs.org/package/replace）也适合您。它不需要您读取然后写入文件。

改编自文档：

// install:

npm install replace 

// require:

var replace = require("replace");

// use:

replace({
    regex: "string to be replaced",
    replacement: "replacement string",
    paths: ['path/to/your/file'],
    recursive: true,
    silent: true,
});

score 31 · Accepted Answer

您还可以使用 ShellJS 中的“sed”函数...

 $ npm install [-g] shelljs


 require('shelljs/global');
 sed('-i', 'search_pattern', 'replace_pattern', file);

完整的文档...

score 5 · Accepted Answer

您可以在使用流读取文件的同时处理文件。这就像使用缓冲区，但使用了更方便的 API。

var fs = require('fs');
function searchReplaceFile(regexpFind, replace, cssFileName) {
    var file = fs.createReadStream(cssFileName, 'utf8');
    var newCss = '';

    file.on('data', function (chunk) {
        newCss += chunk.toString().replace(regexpFind, replace);
    });

    file.on('end', function () {
        fs.writeFile(cssFileName, newCss, function(err) {
            if (err) {
                return console.log(err);
            } else {
                console.log('Updated!');
            }
    });
});

searchReplaceFile(/foo/g, 'bar', 'file.txt');

score 4 · Accepted Answer

在 Linux 或 Mac 上，keep 很简单，只需在 shell 中使用 sed。不需要外部库。以下代码适用于 Linux。

const shell = require('child_process').execSync
shell(`sed -i "s!oldString!newString!g" ./yourFile.js`)

Mac 上的 sed 语法略有不同。我现在无法测试它，但我相信你只需要在“-i”之后添加一个空字符串：

const shell = require('child_process').execSync
shell(`sed -i "" "s!oldString!newString!g" ./yourFile.js`)

最后的“！”之后的“g” 使 sed 替换一行中的所有实例。删除它，只有每行的第一个匹配项将被替换。

score 3 · Accepted Answer

如果有人想为任务使用基于 Promise 的“fs”模块。

const fs = require('fs').promises;

// Below statements must be wrapped inside the 'async' function:
const data = await fs.readFile(someFile, 'utf8');
const result = data.replace(/string to be replaced/g, 'replacement');
await fs.writeFile(someFile, result,'utf8');

score 2 · Accepted Answer

扩展@Sanbor的答案，最有效的方法是将原始文件作为流读取，然后将每个块流式传输到一个新文件中，最后用新文件替换原始文件。

async function findAndReplaceFile(regexFindPattern, replaceValue, originalFile) {
  const updatedFile = `${originalFile}.updated`;

  return new Promise((resolve, reject) => {
    const readStream = fs.createReadStream(originalFile, { encoding: 'utf8', autoClose: true });
    const writeStream = fs.createWriteStream(updatedFile, { encoding: 'utf8', autoClose: true });

    // For each chunk, do the find & replace, and write it to the new file stream
    readStream.on('data', (chunk) => {
      chunk = chunk.toString().replace(regexFindPattern, replaceValue);
      writeStream.write(chunk);
    });

    // Once we've finished reading the original file...
    readStream.on('end', () => {
      writeStream.end(); // emits 'finish' event, executes below statement
    });

    // Replace the original file with the updated file
    writeStream.on('finish', async () => {
      try {
        await _renameFile(originalFile, updatedFile);
        resolve();
      } catch (error) {
        reject(`Error: Error renaming ${originalFile} to ${updatedFile} => ${error.message}`);
      }
    });

    readStream.on('error', (error) => reject(`Error: Error reading ${originalFile} => ${error.message}`));
    writeStream.on('error', (error) => reject(`Error: Error writing to ${updatedFile} => ${error.message}`));
  });
}

async function _renameFile(oldPath, newPath) {
  return new Promise((resolve, reject) => {
    fs.rename(oldPath, newPath, (error) => {
      if (error) {
        reject(error);
      } else {
        resolve();
      }
    });
  });
}

// Testing it...
(async () => {
  try {
    await findAndReplaceFile(/"some regex"/g, "someReplaceValue", "someFilePath");
  } catch(error) {
    console.log(error);
  }
})()

score 1 · Accepted Answer

我在用一大串代码替换一个小的占位符时遇到了问题。

我在做：

var replaced = original.replace('PLACEHOLDER', largeStringVar);

我发现问题出在 JavaScript 的特殊替换模式上，这里有描述。由于我用作替换字符串的代码中有一些$，所以它弄乱了输出。

我的解决方案是使用函数替换选项，它不做任何特殊替换：

var replaced = original.replace('PLACEHOLDER', function() {
    return largeStringVar;
});

score 1 · Accepted Answer

适用于 Node 7.6+ 的 ES2017/8，带有用于原子替换的临时写入文件。

const Promise = require('bluebird')
const fs = Promise.promisifyAll(require('fs'))

async function replaceRegexInFile(file, search, replace){
  let contents = await fs.readFileAsync(file, 'utf8')
  let replaced_contents = contents.replace(search, replace)
  let tmpfile = `${file}.jstmpreplace`
  await fs.writeFileAsync(tmpfile, replaced_contents, 'utf8')
  await fs.renameAsync(tmpfile, file)
  return true
}

请注意，仅适用于小文件，因为它们将被读入内存。

score 1 · Accepted Answer

这可能会帮助某人：

这与全局替换有点不同

从我们运行的终端
node replace.js

替换.js：

function processFile(inputFile, repString = "../") {
var fs = require('fs'),
    readline = require('readline'),
    instream = fs.createReadStream(inputFile),
    outstream = new (require('stream'))(),
    rl = readline.createInterface(instream, outstream);
    formatted = '';   

const regex = /<xsl:include href="([^"]*)" \/>$/gm;

rl.on('line', function (line) {
    let url = '';
    let m;
    while ((m = regex.exec(line)) !== null) {
        // This is necessary to avoid infinite loops with zero-width matches
        if (m.index === regex.lastIndex) {
            regex.lastIndex++;
        }
        
        url = m[1];
    }

    let re = new RegExp('^.* <xsl:include href="(.*?)" \/>.*$', 'gm');

    formatted += line.replace(re, `\t<xsl:include href="${repString}${url}" />`);
    formatted += "\n";
});

rl.on('close', function (line) {
    fs.writeFile(inputFile, formatted, 'utf8', function (err) {
        if (err) return console.log(err);
    });

});
}


// path is relative to where your running the command from
processFile('build/some.xslt');

这就是这样做的。我们有几个文件有 xml:includes

然而，在开发中，我们需要向下移动一个级别的路径。

由此

<xsl:include href="common/some.xslt" />

对此

<xsl:include href="../common/some.xslt" />

因此，我们最终运行了两种 regx 模式，一种用于获取 href，另一种用于编写可能有更好的方法来执行此操作，但它现在可以工作。

谢谢

score 0 · Accepted Answer

我会改用双工流。像这里记录的nodejs doc双工流

转换流是双工流，其中输出以某种方式从输入中计算出来。

score 0 · Accepted Answer

<p>Please click in the following {{link}} to verify the account</p>


function renderHTML(templatePath: string, object) {
    const template = fileSystem.readFileSync(path.join(Application.staticDirectory, templatePath + '.html'), 'utf8');
    return template.match(/\{{(.*?)\}}/ig).reduce((acc, binding) => {
        const property = binding.substring(2, binding.length - 2);
        return `${acc}${template.replace(/\{{(.*?)\}}/, object[property])}`;
    }, '');
}

renderHTML(templateName, { link: 'SomeLink' })

当然，您可以改进阅读模板功能以作为流读取并逐行组合字节以提高效率

score 0 · Accepted Answer

Nomaly，我tiny-replace-files用来替换文件或文件中的文本。这个 pkg 更小更轻... https://github.com/Rabbitzzc/tiny-replace-files

import { replaceStringInFilesSync } from 'tiny-replace-files'

const options = {
  files: 'src/targets/index.js',
  from: 'test-plugin',
  to: 'self-name',
}

# await
const result = replaceStringInFilesSync(options)
console.info(result)

javascript - 用nodejs替换文件中的字符串

14 回答 14

Related

Reference