feat(file): withFiles

seb-cr · May 22, 2023 · 6371b8f · 6371b8f
1 parent 484612f
commit 6371b8f
Show file tree

Hide file tree

Showing 12 changed files with 769 additions and 63 deletions.
diff --git a/.eslintrc.yml b/.eslintrc.yml
@@ -6,5 +6,6 @@ extends:
   - '@comicrelief/eslint-config/mixins/jsdoc'
 
 rules:
+  no-continue: off
   '@typescript-eslint/no-non-null-assertion': off
   '@typescript-eslint/no-explicit-any': off
diff --git a/README.md b/README.md
@@ -103,6 +103,20 @@ await withYamlFile('example.yaml', (f) => {
 });
 ```
 
+### `withFiles(search: WithFilesOptions, callback: (f: Text) => void | Promise<void>): Promise<void>`
+
+Work on text files that match the given search criteria.
+
+```ts
+// replace every occurrance of 'foo' with 'bar' in every JS file
+await withFiles({
+  include: '**.js',
+  containing: 'foo',
+}, (f) => {
+  f.replaceAll('foo', 'bar');
+});
+```
+
 ## Test helpers
 
 ### `sh.mock()`