feat(text): replaceAll

README.md

@@ -45,7 +45,7 @@ Work with text files using the `withFile` function. It opens the file, passes th
 
 ```ts
 await withFile('example.txt', (f) => {
-  // ...
+  f.replaceAll('old', 'new');
 });
 ```
 

src/regex.ts

@@ -0,0 +1,29 @@
+/*
+  Helpers for working with RegExp objects.
+*/
+
+/**
+ * Escapes characters in `string` so that it can be used to build a RegExp.
+ *
+ * Source: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping
+ *
+ * @param string
+ */
+export function escapeRegex(string: string): string {
+  return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+}
+
+/**
+ * Turns a search value (string or RegExp) into a global RegExp.
+ *
+ * @param input
+ */
+export function globalRegex(input: string | RegExp): RegExp {
+  if (typeof input === 'string') {
+    return new RegExp(escapeRegex(input), 'g');
+  }
+  if (input.global) {
+    return input;
+  }
+  return new RegExp(input, `${input.flags}g`);
+}

src/text.ts

@@ -1,3 +1,5 @@
+import { globalRegex } from './regex';
+
 /**
  * Class for manipulating a block of text.
  */
@@ -17,4 +19,15 @@ export class Text {
   lines(): string[] {
     return this.content.split('\n');
   }
+
+  /**
+   * Replace every occurrance of `searchValue` with `replaceValue`.
+   *
+   * @param searchValue
+   * @param replaceValue
+   */
+  replaceAll(searchValue: string | RegExp, replaceValue: string): void {
+    const pattern = globalRegex(searchValue);
+    this.content = this.content.replace(pattern, replaceValue);
+  }
 }

tests/text.spec.ts

@@ -22,4 +22,30 @@ describe('Text', () => {
       expect(text.lines()).to.deep.equal(['one', 'two', 'three']);
     });
   });
+
+  describe('replaceAll', () => {
+    it('should work with a string', () => {
+      const text = new Text('one. two. three');
+      text.replaceAll('.', ',');
+      expect(text.content).to.equal('one, two, three');
+    });
+
+    it('should work with a non-global regex', () => {
+      const text = new Text('one. two. three');
+      text.replaceAll(/./, 'z');
+      expect(text.content).to.equal('zzzzzzzzzzzzzzz');
+    });
+
+    it('should work with a global regex', () => {
+      const text = new Text('one. two. three');
+      text.replaceAll(/\w/g, 'z');
+      expect(text.content).to.equal('zzz. zzz. zzzzz');
+    });
+
+    it('should cover all lines', () => {
+      const text = new Text('one.\ntwo.\nthree.');
+      text.replaceAll('.', '!');
+      expect(text.content).to.equal('one!\ntwo!\nthree!');
+    });
+  });
 });