esc-file-replace-substring

Replace (with option to append) string or RegEx in a file, if different vs old contents (SSD/flash memory friendly).

Installation

npm install esc-file-replace-substring

Use

1import fileReplaceSubstring from 'esc-file-replace-substring';
2fileReplaceSubstring(filePath, 'normal', 'special');

Example

(see test.mjs)

1const show = () => console.log('---\n' + fs.readFileSync(filePath) + '---');
2
3fs.writeFileSync(filePath, 'This is a normal config file\nFOO=friend\nBAR=bear\n');
4
5show();
6
7fileReplaceSubstring(filePath, /^\s*FOO=.+/gm, 'FOO=fantastic');
8
9show();
10
11fileReplaceSubstring(filePath, /^\s*ZOO=.+/gm, 'ZOO=zebra', 'append');
12
13show();
14
15fileReplaceSubstring(filePath, /^\s*ZOO=.+/gm, 'ZOO=zzzzz', 'append');
16
17show();
18
19fileReplaceSubstring(filePath, 'normal', 'special');
20
21show();

console.log override-able

Pass in your own logging functions for

• Changed
• Not found (disabled by default)
• Unchanged (disabled by default)

Project goals

• SSD/flash friendly, only writes if the contents of the file will change
• No dependencies
• No nonsense
• Reliable, no radical changes will ever happen.
• Small, simple, easy to audit, yourself

If I have ideas for something different, I'll make a new package rather than make breaking changes.

See also

• https://www.npmjs.com/package/esc-file-replace-substring-between-comments
• https://www.npmjs.com/package/esc-file-replace-contents
• https://www.npmjs.com/package/esc-read-file-without-comments
• https://www.npmjs.com/package/esc-get-data-from-json-file

Notes

Have fun!

Say thanks

Star the repo https://github.com/softwarecreations/esc-file-replace-substring

PR's or issues

Welcome

License

MIT