Installation

# Using npmnpm install replace-in-files# Using yarnyarn add replace-in-files

Usage

Specify options

constreplaceInFiles=require('replace-in-files');constoptions={// See more: https://www.npmjs.com/package/globby// Single file or globfiles:'path/to/file',// Multiple files or globsfiles:['path/to/file','path/to/other/file','path/to/files/*.html','another/**/*.path',],// See more: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replace// Replacementfrom:/foo/g,// string or regexto:'bar',// string or fn  (fn: carrying last argument - path to replaced file)// See more: https://www.npmjs.com/package/globoptionsForFiles:{// default"ignore":["**/node_modules/**"]}// format: `${fileName}-${year}-${month}-${day}_${hour}:${minute}:${second}.{fileExtension}`//            fileName-2017-11-01_21:29:55.js// date of createFile old file or last modificate (if not find create date)saveOldFile:false// default//Character encoding for reading/writing filesencoding: 'utf8',// defaultshouldSkipBinaryFiles:true,// defaultonlyFindPathsWithoutReplace:false// defaultreturnPaths:true// defaultreturnCountOfMatchesByPaths:true// default};

Replacing multiple occurrences

Asynchronous replacement with promises

constreplaceInFiles=require('replace-in-files');// ...replaceInFiles(options).then(({ changedFiles, countOfMatchesByPaths})=>{console.log('Modified files:',changedFiles);console.log('Count of matches by paths:',countOfMatchesByPaths);console.log('was called with:',options);}).catch(error=>{console.error('Error occurred:',error);});

Asynchronous replacement with co yield

constreplaceInFiles=require('replace-in-files');constco=require('co');// ...co(function*(){const{    changedFiles,    countOfMatchesByPaths,    replaceInFilesOptions}=yieldreplaceInFiles(options);console.log('Modified files:',changedFiles);console.log('Count of matches by paths:',countOfMatchesByPaths);console.log('was called with:',replaceInFilesOptions);}).catch((error)=>{console.log('Error occurred:',error);});

Asynchronous replacement with async await (node 8+)

constreplaceInFiles=require('replace-in-files');// ...asyncfunctionmain(){try{const{      changedFiles,      countOfMatchesByPaths,      replaceInFilesOptions}=awaitreplaceInFiles(options);console.log('Modified files:',changedFiles);console.log('Count of matches by paths:',countOfMatchesByPaths);console.log('was called with:',replaceInFilesOptions);}catch(error){console.log('Error occurred:',error);}}main();

Sequentially replacement

constreplaceInFiles=require('replace-in-files');// ...asyncfunctionmain(){try{const{      changedFiles,      countOfMatchesByPaths,      replaceInFilesOptions}=awaitreplaceInFiles(options).pipe({from:'foo',to:'bar'}).pipe({from:'first',to:'second'}).pipe({from:/const/g,to:()=>'var'});console.log('Modified files:',changedFiles);console.log('Count of matches by paths:',countOfMatchesByPaths);console.log('was called with:',replaceInFilesOptions);}catch(error){console.log('Error occurred:',error);}}main();

Return value

constreplaceInFiles=require('replace-in-files');constdata=replaceInFiles({files:'path/to/files/*.html',from:'a',to:'b',});// data could like:{countOfMatchesByPaths:[{'path/to/files/file1.html':5,'path/to/files/file3.html':1,'path/to/files/file5.html':3}],paths:['path/to/files/file1.html','path/to/files/file3.html','path/to/files/file5.html',],replaceInFilesOptions:[{files:'path/to/files/*.html',from:'a',to:'b',}]}// if empty:{countOfMatchesByPaths:[{}],paths:[]}// if used 2 .pipe{countOfMatchesByPaths:[{'path/to/files/file1.html':5,'path/to/files/file3.html':1,'path/to/files/file5.html':3},{'path/to/files/file5.html':4},{'path/to/files/file1.html':2,'path/to/files/file5.html':4}],paths:['path/to/files/file1.html','path/to/files/file3.html','path/to/files/file5.html',],replaceInFilesOptions:[{files:'path/to/files/*.html',from:'a',to:'b',},{from:'c',to:'d',},{from:'e',to:'f',}]}

Version information

License