Custom processor with two arguments (#186)

* Custom processor with additional argument which receives the file being processed * Update lib/process-file.spec.js Co-authored-by: Adam Reis <[email protected]> * Update lib/process-file.spec.js Co-authored-by: Adam Reis <[email protected]> * Update lib/helpers/run-processors.js Co-authored-by: Adam Reis <[email protected]> * Update README.md Co-authored-by: Adam Reis <[email protected]> * Update README.md Co-authored-by: Adam Reis <[email protected]> * cleanup --------- Co-authored-by: Kevin Sommer <[email protected]> Co-authored-by: Adam Reis <[email protected]>
adamreisnz · Feb 14, 2024 · e90c51f · e90c51f
1 parent 3b936d9
commit e90c51f
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -205,6 +205,14 @@ const results = replace.sync({
   processor: (input) => input.replace(/foo/g, 'bar'),
 });
 ```
+The custom processor will receive the path of the file being processed as a second parameter:
+
+```js
+const results = replace.sync({
+  files: 'path/to/files/*.html',
+  processor: (input, file) => input.replace(/foo/g, file),
+});
+```
 
 ### Array of custom processors
 

diff --git a/lib/helpers/run-processors.js b/lib/helpers/run-processors.js
@@ -6,7 +6,7 @@ module.exports = function runProcessors(contents, processor, file) {
   const result = {file};
 
   const newContents = processors.reduce((contents, processor) => {
-    return processor(contents);
+    return processor(contents, file);
   }, contents);
 
   result.hasChanged = (newContents !== contents);

diff --git a/lib/process-file.spec.js b/lib/process-file.spec.js
@@ -42,6 +42,13 @@ describe('Process a file', () => {
     return config;
   }
 
+  function appendFileProcessor(config) {
+    config.processor = (content, file) => {
+      return `${content}${file}`;
+    };
+    return config;
+  }
+
   /**
    * Async with promises
    */
@@ -754,6 +761,18 @@ describe('Process a file', () => {
       expect(results[2].hasChanged).to.equal(false);
     });
 
+    it('should pass filename to processor as second parameter', () => {
+      transform.sync(appendFileProcessor({
+        files: 'test*',
+      }));
+      const test1 = fs.readFileSync('test1', 'utf8');
+      const test2 = fs.readFileSync('test2', 'utf8');
+      const test3 = fs.readFileSync('test3', 'utf8');
+      expect(test1).to.equal(`${testData}test1`);
+      expect(test2).to.equal(`${testData}test2`);
+      expect(test3).to.equal('nopetest3');
+    });
+
     describe('fs', () => {
       it('reads and writes using a custom fs when provided', done => {
         const before = 'a';