@putout/engine-runner 20.0.5 → 20.2.0

package/README.md

@@ -214,16 +214,48 @@ 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);
 };
 ```
 
+You can also subscribe to `progress` events:
+
+- `start`;
+- `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/index.js

@@ -12,20 +12,22 @@ const replace = require('./replace');
 const declare = require('./declare');
 const scanner = require('./scanner');
 const template = require('./template');
+const {createProgress} = require('./progress');
 
 const {getPath, getPosition} = require('./get-position');
 
 const isRemoved = (a) => a?.removed;
 
-module.exports.runPlugins = ({ast, shebang, fix, fixCount, plugins}) => {
+module.exports.runPlugins = ({ast, shebang, fix, fixCount, plugins, progress = createProgress()}) => {
     let places = [];
     
     const merge = once(mergeVisitors);
-    
     const {
         pluginsFind,
         pluginsTraverse,
-    } = splitPlugins(plugins);
+    } = splitPlugins(plugins, {
+        progress,
+    });
     
     for (let i = 0; i < fixCount; i++) {
         places = run({
@@ -38,6 +40,8 @@ module.exports.runPlugins = ({ast, shebang, fix, fixCount, plugins}) => {
             template,
         });
         
+        progress.reset();
+        
         if (!fix || !places.length)
             return places;
         
@@ -142,7 +146,7 @@ function runWithoutMerge({ast, fix, shebang, template, pluginsFind}) {
     return places;
 }
 
-function splitPlugins(plugins) {
+function splitPlugins(plugins, {progress}) {
     const pluginsFind = [];
     const pluginsTraverse = [];
     
@@ -175,7 +179,9 @@ function splitPlugins(plugins) {
         }
         
         if (plugin.scan) {
-            pluginsTraverse.push(scanner(item));
+            pluginsTraverse.push(scanner(item, {
+                progress,
+            }));
             continue;
         }
     }

package/lib/progress.js

@@ -0,0 +1,54 @@
+'use strict';
+
+const {EventEmitter} = require('events');
+
+module.exports.createProgress = () => {
+    let pluginsCount = 0;
+    let pluginsIndex = 0;
+    
+    const progress = new EventEmitter();
+    
+    progress.reset = () => {
+        pluginsIndex = 0;
+        pluginsCount = 0;
+    };
+    
+    progress.file = ({i, n, rule}) => {
+        progress.emit('file', {
+            i,
+            n,
+            rule,
+        });
+    };
+    
+    progress.inc = () => {
+        ++pluginsCount;
+    };
+    
+    progress.start = (rule) => {
+        ++pluginsIndex;
+        progress.emit('start', {
+            pluginsIndex,
+            pluginsCount,
+            rule,
+        });
+    };
+    
+    progress.push = (rule) => {
+        progress.emit('push', {
+            pluginsIndex,
+            pluginsCount,
+            rule,
+        });
+    };
+    
+    progress.end = (rule) => {
+        progress.emit('end', {
+            rule,
+            pluginsIndex,
+            pluginsCount,
+        });
+    };
+    
+    return progress;
+};

package/lib/scanner/index.js

@@ -9,16 +9,19 @@ const log = require('debug')('putout:runner:scanner');
 const fromSimple = require('@putout/plugin-filesystem/from-simple');
 const toSimple = require('@putout/plugin-filesystem/to-simple');
 
-module.exports = ({rule, plugin, msg, options}) => {
+module.exports = ({rule, plugin, msg, options}, {progress}) => {
     const {
         scan,
         report,
         fix,
     } = plugin;
     
+    progress.inc();
+    
     const traverse = getTraverse({
         scan,
         rule,
+        progress,
     });
     
     return {
@@ -33,9 +36,23 @@ module.exports = ({rule, plugin, msg, options}) => {
     };
 };
 
-const getTraverse = ({scan, rule}) => ({push, options}) => ({
+const watchPush = ({push, rule, progress}) => (...a) => {
+    progress.push(rule);
+    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);
+        progress.start(rule);
         
         const rootPath = path.get('arguments.0');
         const isSimple = fullstore(false);
@@ -47,7 +64,15 @@ const getTraverse = ({scan, rule}) => ({push, options}) => ({
         });
         
         scan(rootPath, {
-            push,
+            push: watchPush({
+                push,
+                rule,
+                progress,
+            }),
+            progress: createFileProgress({
+                rule,
+                progress,
+            }),
             options,
         });
         
@@ -57,6 +82,8 @@ const getTraverse = ({scan, rule}) => ({push, options}) => ({
             rootPath,
             isSimple,
         });
+        
+        progress.end(rule);
     },
 });
 

package/package.json

@@ -1,11 +1,15 @@
 {
   "name": "@putout/engine-runner",
-  "version": "20.0.5",
+  "version": "20.2.0",
   "type": "commonjs",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "Run 🐊Putout plugins",
   "homepage": "https://github.com/coderaiser/putout/tree/master/packages/engine-runner#readme",
-  "main": "lib/index.js",
+  "main": "./lib/index.js",
+  "exports": {
+    ".": "./lib/index.js",
+    "./progress": "./lib/progress.js"
+  },
   "release": false,
   "tag": false,
   "changelog": false,