Замініть рядок у файлі на nodejs

Я використовую md5 grunt завдання для створення файлів MD5. Тепер я хочу перейменувати джерела у файлі HTML з новим іменем файлу у зворотному дзвінку завдання. Цікаво, який найпростіший спосіб зробити це.

Ви можете використовувати простий регулярний вираз:

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);
  });
});

Оскільки заміни не працює для мене, я створив простий пакет NPM заміну на файл , щоб швидко замінити текст в одному або декількох файлах. Частково це ґрунтується на відповіді @ asgoth.

Редагувати (3 жовтня 2016 р.) : Пакет тепер підтримує обіцянки та глобус, і інструкції з використання були оновлені, щоб відобразити це.

Редагувати (16 березня 2018 р.) . Зараз пакет набрав понад 100 тис. Завантажень щомісяця та був розширений додатковими функціями, а також інструментом 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',
};

Асинхронна заміна обіцянками:

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);
}

Можливо, модуль "Замінити" ( 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,
});

Ви також можете використовувати функцію "sed", що є частиною ShellJS ...

 $ npm install [-g] shelljs


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

Відвідайте ShellJs.org для отримання додаткових прикладів.

Ви можете обробити файл під час читання, використовуючи потоки. Це так само, як використовувати буфери, але з більш зручним 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');

У мене виникли проблеми під час заміни невеликого заповнювача на великий рядок коду.

Я робив:

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

Я зрозумів, що проблема полягає в особливих моделях заміни JavaScript, описаних тут . Оскільки код, який я використовував як рядок, що заміняв, мав $у ньому деякі , він псував вихід.

Моє рішення полягало у використанні опції заміни функції, яка НЕ ​​робить будь-якої спеціальної заміни:

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

ES2017 / 8 для Node 7.6+ з тимчасовим файлом запису для заміни атомів.

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
}

Зауважте, лише для невеликих файлів, оскільки вони будуть читатися в пам'яті.

На Linux або Mac зберігати просто і просто використовувати sed з оболонкою. Не потрібні зовнішні бібліотеки. Наступний код працює в Linux.

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

Синтаксис sed дещо відрізняється на Mac. Я не можу перевірити його зараз, але я вважаю, що вам просто потрібно додати порожній рядок після "-i":

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

"G" після фіналу "!" змушує sed замінювати всі екземпляри лінії. Видаліть його, і буде замінено лише перше виникнення в рядку.

Розгортаючись на відповідь @ 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);
  }
})()

Я б замість цього використовував дуплексний потік. як задокументовані тут nodejs doc дуплексні потоки

Трансформаційний потік - це дуплексний потік, де вихід обчислюється якимось чином із входу.

<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' })

Ви точно можете вдосконалити функцію шаблону читання, щоб читати як потік, і складати байти за рядком, щоб зробити його більш ефективним