@putout/engine-runner 19.0.1 → 19.1.0

package/README.md

@@ -19,6 +19,7 @@ There is a couple plugin types available in 🐊**Putout**:
 - ✅ [**Replacer**](#replacer)
 - ✅ [**Includer**](#includer)
 - ✅ [**Traverser**](#traverser)
+- ✅ [**Scanner**](#filer)
 - ✅ [**Finder**](#finder)
 
 All of them supports subset of **JavaScript** 🦎[**PutoutScript**](https://github.com/coderaiser/putout/blob/master/docs/putout-script.md#-putoutscript) described in [`@putout/compare`](https://github.com/coderaiser/putout/tree/master/packages/compare#readme).
@@ -39,7 +40,7 @@ Based on [`@putout/operator-declare`](https://github.com/coderaiser/putout/tree/
 
 ### Replacer
 
-**Replacer** converts code in declarative way. Simplest possible form, no need to use `fix`. Just `from` and `to` parts
+**Replacer** converts code in declarative way. Simplest possible form of 🐊**Putout Plugin**, no need to use `fix`. Just `from` and `to` parts
 according to [`template variables syntax`](https://github.com/coderaiser/putout/tree/master/packages/compare#supported-template-variables).
 
 Simplest replace example:
@@ -202,6 +203,27 @@ module.exports.traverse = ({push}) => ({
 });
 ```
 
+### Scanner
+
+**Scanner** gives you all ability to work with files.
+
+```js
+module.exports.report = () => 'Create file hello.txt';
+
+module.exports.fix = (rootPath) => {
+    createFile(rootPath, 'hello.txt', 'hello world');
+};
+
+module.exports.scan = (rootPath) => {
+    const [filePath] = findFile(rootPath, 'hello.txt');
+    
+    if (filePath)
+        return null;
+    
+    return rootPath;
+};
+```
+
 ### Finder
 
 **Finder** gives you all the control over traversing, but it's the slowest format.

package/lib/get-position.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const getPath = (item) => item.path || item;
+const getPath = (item) => item.path || item[0] || item;
 
 module.exports.getPath = getPath;
 module.exports.getPosition = (path, shebang) => {

package/lib/index.js

@@ -10,12 +10,14 @@ const superFind = require('./super-find');
 const include = require('./include');
 const replace = require('./replace');
 const declare = require('./declare');
+const scanner = require('./scanner');
+const template = require('./template');
 
 const {getPath, getPosition} = require('./get-position');
 
 const isRemoved = (a) => a?.removed;
 
-module.exports.runPlugins = ({ast, shebang, fix, fixCount, plugins, template = require('./template')}) => {
+module.exports.runPlugins = ({ast, shebang, fix, fixCount, plugins}) => {
     let places = [];
     
     const merge = once(mergeVisitors);
@@ -171,6 +173,11 @@ function splitPlugins(plugins) {
             pluginsTraverse.push(include(item));
             continue;
         }
+        
+        if (plugin.scan) {
+            pluginsTraverse.push(scanner(item));
+            continue;
+        }
     }
     
     return {

package/lib/merge-visitors.js

@@ -102,9 +102,9 @@ function getStore(plugin, {fix, rule, shebang, msg, options}) {
     const uplist = upListStore();
     const paths = pathStore();
     
-    const push = (path) => {
+    const push = (path, pathOptions) => {
         const position = getPosition(path, shebang);
-        const message = msg || plugin.report(path);
+        const message = msg || plugin.report(path, pathOptions);
         
         placesStore({
             message,
@@ -113,6 +113,7 @@ function getStore(plugin, {fix, rule, shebang, msg, options}) {
         
         runFix(fix, plugin.fix, {
             path,
+            pathOptions,
             rule,
             position,
             options,

package/lib/replace/index.js

@@ -27,6 +27,7 @@ const PRINT_OPTIONS = {
             newline: '',
             indent: '',
             splitter: ' ',
+            endOfFile: '',
         },
     }],
 };
@@ -148,9 +149,8 @@ const getFilter = (match = stubMatch, options) => (path) => {
     for (const [from, matchProperty] of all) {
         const nodeFrom = template.ast(from);
         
-        if (!compare(path.node, nodeFrom)) {
+        if (!compare(path.node, nodeFrom))
             continue;
-        }
         
         const waysFrom = findVarsWays(nodeFrom);
         const {node} = path;

package/lib/replace/watermark.js

@@ -9,9 +9,7 @@ const hasWatermark = (watermark) => (path) => path.node?.[name]?.has(watermark);
 
 module.exports = (from, to, path) => {
     const {watermark, highWatermark} = create(from, to, path);
-    
     const program = path.findParent(isProgram) || path;
-    
     const options = {
         watermark,
         highWatermark,
@@ -41,9 +39,8 @@ function create(from, to, path) {
 
 module.exports.init = init;
 function init({path, program}) {
-    if (path.node) {
+    if (path.node)
         path.node[name] = path.node[name] || new Set();
-    }
     
     program.node[name] = program.node[name] || new Set();
 }

package/lib/run-fix.js

@@ -8,10 +8,25 @@ const {stringify} = JSON;
 const isFn = (a) => typeof a === 'function';
 const getPath = (path) => path.path || path;
 
-const tryToFix = (fix, {path, position, options}) => {
-    const [e] = tryCatch(fix, path, {
+const chooseFixArgs = ({path, pathOptions, options}) => {
+    if (pathOptions)
+        return [
+            path,
+            pathOptions, {
+                options,
+            }];
+    
+    return [path, {
         options,
-    });
+    }];
+};
+
+const tryToFix = (fix, {path, pathOptions, position, options}) => {
+    const [e] = tryCatch(fix, ...chooseFixArgs({
+        path,
+        pathOptions,
+        options,
+    }));
     
     const {scope} = path.path || path;
     
@@ -20,16 +35,15 @@ const tryToFix = (fix, {path, position, options}) => {
             .getProgramParent()
             .crawl();
     
-    if (!e) {
+    if (!e)
         return;
-    }
     
     e.loc = e.loc || position;
     
     throw e;
 };
 
-module.exports = (is, fix, {path, rule, position, options}) => {
+module.exports = (is, fix, {path, pathOptions, rule, position, options}) => {
     if (!is)
         return;
     
@@ -40,6 +54,7 @@ module.exports = (is, fix, {path, rule, position, options}) => {
     
     tryToFix(fix, {
         path,
+        pathOptions,
         position,
         options,
     });

package/lib/scanner/index.js

@@ -0,0 +1,40 @@
+'use strict';
+
+const {__filesystem} = require('@putout/operator-json');
+const log = require('debug')('putout:runner:scanner');
+
+module.exports = ({rule, plugin, msg, options}) => {
+    const {
+        scan,
+        report,
+        fix,
+    } = plugin;
+    
+    const traverse = getTraverse({
+        scan,
+        rule,
+    });
+    
+    return {
+        rule,
+        msg,
+        options,
+        plugin: {
+            report,
+            fix,
+            traverse,
+        },
+    };
+};
+
+const getTraverse = ({scan, rule}) => ({push, options}) => ({
+    [__filesystem](path) {
+        log(rule);
+        
+        const rootPath = path.get('arguments.0');
+        scan(rootPath, {
+            push,
+            options,
+        });
+    },
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@putout/engine-runner",
-  "version": "19.0.1",
+  "version": "19.1.0",
   "type": "commonjs",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "Run 🐊Putout plugins",
@@ -29,6 +29,7 @@
     "@putout/engine-parser": "^9.0.0",
     "@putout/operate": "^11.0.0",
     "@putout/operator-declare": "^8.0.0",
+    "@putout/operator-json": "^1.3.0",
     "debug": "^4.1.1",
     "jessy": "^3.0.0",
     "nessy": "^4.0.0",
@@ -41,11 +42,12 @@
     "putout-engine"
   ],
   "devDependencies": {
+    "@putout/operator-filesystem": "^2.9.2",
     "@putout/plugin-minify": "*",
     "c8": "^8.0.0",
     "eslint": "^8.0.1",
     "eslint-plugin-n": "^16.0.0",
-    "eslint-plugin-putout": "^19.0.0",
+    "eslint-plugin-putout": "^21.0.0",
     "just-camel-case": "^4.0.2",
     "lerna": "^6.0.1",
     "madrun": "^9.0.0",