@putout/engine-runner 20.1.0 → 20.2.0

package/README.md

@@ -214,13 +214,13 @@ module.exports.fix = (rootPath) => {
     createFile(rootPath, 'hello.txt', 'hello world');
 };
 
-module.exports.scan = (rootPath) => {
+module.exports.scan = (rootPath, {push}) => {
     const [filePath] = findFile(rootPath, 'hello.txt');
     
     if (filePath)
         return null;
     
-    return rootPath;
+    push(rootPath);
 };
 ```
 
@@ -230,6 +230,32 @@ You can also subscribe to `progress` events:
 - `end`;
 - `push`;
 
+And one more: `file` if your plugin uses `progress` function:
+
+```js
+export const report = () => 'Create file hello.txt';
+
+export const fix = (rootPath) => {
+    createFile(rootPath, 'hello.txt', 'hello world');
+};
+
+export const scan = (rootPath) => {
+    const [filePath] = findFile(rootPath, 'hello.txt');
+    
+    if (filePath)
+        return null;
+    
+    progress({
+        i: 0,
+        n: 1,
+    });
+    
+    push(filePath);
+};
+```
+
+
+
 ### Finder
 
 **Finder** gives you all the control over traversing, but it's the slowest format.

package/lib/progress.js

@@ -13,6 +13,14 @@ module.exports.createProgress = () => {
         pluginsCount = 0;
     };
     
+    progress.file = ({i, n, rule}) => {
+        progress.emit('file', {
+            i,
+            n,
+            rule,
+        });
+    };
+    
     progress.inc = () => {
         ++pluginsCount;
     };

package/lib/scanner/index.js

@@ -41,6 +41,14 @@ const watchPush = ({push, rule, progress}) => (...a) => {
     push(...a);
 };
 
+const createFileProgress = ({rule, progress}) => ({i, n}) => {
+    progress.file({
+        i,
+        n,
+        rule,
+    });
+};
+
 const getTraverse = ({scan, rule, progress}) => ({push, options}) => ({
     ['__putout_processor_filesystem(__)'](path) {
         log(rule);
@@ -61,6 +69,10 @@ const getTraverse = ({scan, rule, progress}) => ({push, options}) => ({
                 rule,
                 progress,
             }),
+            progress: createFileProgress({
+                rule,
+                progress,
+            }),
             options,
         });
         

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@putout/engine-runner",
-  "version": "20.1.0",
+  "version": "20.2.0",
   "type": "commonjs",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "Run 🐊Putout plugins",