@putout/engine-runner 21.0.3 → 21.2.0

package/README.md

@@ -203,123 +203,7 @@ 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, {push}) => {
-    const [filePath] = findFile(rootPath, 'hello.txt');
-    
-    if (filePath)
-        return null;
-    
-    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, {progress}) => {
-    const [filePath] = findFile(rootPath, 'hello.txt');
-    
-    if (filePath)
-        return null;
-    
-    progress({
-        i: 0,
-        n: 1,
-    });
-    
-    push(filePath);
-};
-```
-
-Or better `trackFile`, which does the same, but also count `progress`:
-
-```js
-export const report = () => 'Add file';
-export const fix = (file) => {
-    writeFileContent(file, 'hello');
-};
-
-export const scan = (rootPath, {push, trackFile}) => {
-    for (const file of trackFile(rootPath, 'hello.txt')) {
-        push(file);
-    }
-};
-```
-
-### Finder
-
-**Finder** gives you all the control over traversing, but it's the slowest format.
-Because `traversers` not merged in contrast with other plugin formats.
-
-```js
-module.exports.report = () => 'debugger statement should not be used';
-
-module.exports.fix = (path) => {
-    path.remove();
-};
-
-module.exports.find = (ast, {push, traverse}) => {
-    traverse(ast, {
-        'debugger'(path) {
-            push(path);
-        },
-    });
-};
-```
-
-## Example
-
-```js
-const {runPlugins} = require('@putout/engine-runner');
-const {parse} = require('@putout/engine-parser');
-
-const plugins = [{
-    rule: 'remove-debugger',
-    msg: '', // optional
-    options: {}, // optional
-    plugin: {
-        include: () => ['debugger'],
-        fix: (path) => path.remove(),
-        report: () => `debugger should not be used`,
-    },
-}];
-
-const ast = parse('const m = "hi"; debugger');
-
-const places = runPlugins({
-    ast,
-    shebang: false, // default
-    fix: false, // default
-    fixCount: 0, // default
-    plugins,
-    parser: 'babel', // default
-});
-```
-
-## Stores
+#### Stores
 
 Stores is preferred way of keeping 🐊**Putout** data, `traverse` init function called only once, and any other way
 of handling variables will most likely will lead to bugs. There is a couple store types:
@@ -332,7 +216,7 @@ of handling variables will most likely will lead to bugs. There is a couple stor
 
 Let's talk about each of them.
 
-### `listStore`
+##### `listStore`
 
 To save things as a list without duplicates use `listStore`.
 Let's suppose you have such code:
@@ -369,7 +253,7 @@ module.exports.traverse = ({listStore}) => ({
 });
 ```
 
-### `pathStore`
+##### `pathStore`
 
 When you want additional check that `path` not removed.
 
@@ -397,7 +281,7 @@ module.exports.traverse = ({pathStore}) => ({
 });
 ```
 
-### `store`
+##### `store`
 
 When you need `key-value` use `store`:
 
@@ -426,7 +310,7 @@ module.exports.traverse = ({push, store}) => ({
 });
 ```
 
-### `upstore`
+##### `upstore`
 
 When you need to update already saved values, use `upstore`:
 
@@ -463,7 +347,7 @@ module.exports.traverse = ({push, upstore}) => ({
 });
 ```
 
-### `uplist`
+##### `uplist`
 
 When you need to update named arrays:
 
@@ -500,6 +384,122 @@ module.exports.traverse = ({uplist, 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, {push}) => {
+    const [filePath] = findFile(rootPath, 'hello.txt');
+    
+    if (filePath)
+        return null;
+    
+    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, {progress}) => {
+    const [filePath] = findFile(rootPath, 'hello.txt');
+    
+    if (filePath)
+        return null;
+    
+    progress({
+        i: 0,
+        n: 1,
+    });
+    
+    push(filePath);
+};
+```
+
+Or better `trackFile`, which does the same, but also count `progress`:
+
+```js
+export const report = () => 'Add file';
+export const fix = (file) => {
+    writeFileContent(file, 'hello');
+};
+
+export const scan = (rootPath, {push, trackFile}) => {
+    for (const file of trackFile(rootPath, 'hello.txt')) {
+        push(file);
+    }
+};
+```
+
+### Finder
+
+**Finder** gives you all the control over traversing, but it's the slowest format.
+Because `traversers` not merged in contrast with other plugin formats.
+
+```js
+module.exports.report = () => 'debugger statement should not be used';
+
+module.exports.fix = (path) => {
+    path.remove();
+};
+
+module.exports.find = (ast, {push, traverse}) => {
+    traverse(ast, {
+        'debugger'(path) {
+            push(path);
+        },
+    });
+};
+```
+
+## Example
+
+```js
+const {runPlugins} = require('@putout/engine-runner');
+const {parse} = require('@putout/engine-parser');
+
+const plugins = [{
+    rule: 'remove-debugger',
+    msg: '', // optional
+    options: {}, // optional
+    plugin: {
+        include: () => ['debugger'],
+        fix: (path) => path.remove(),
+        report: () => `debugger should not be used`,
+    },
+}];
+
+const ast = parse('const m = "hi"; debugger');
+
+const places = runPlugins({
+    ast,
+    shebang: false, // default
+    fix: false, // default
+    fixCount: 0, // default
+    plugins,
+    parser: 'babel', // default
+});
+```
+
 ## Logs
 
 To see logs, use:

package/lib/include.js

@@ -2,11 +2,10 @@
 
 const log = require('debug')('putout:runner:include');
 const maybeArray = require('./maybe-array');
+const {validate} = require('./validate');
 
-const {stringify} = JSON;
 const stub = () => [];
 const good = () => true;
-const isFn = (a) => typeof a === 'function';
 
 module.exports = ({rule, plugin, msg, options}) => {
     const {
@@ -64,8 +63,3 @@ const getTraverse = (include, filter, rule) => ({push, options}) => {
     
     return result;
 };
-
-function validate(name, fn) {
-    if (!isFn(fn))
-        throw Error(`☝️ Looks like '${name}' is not a 'function' but '${typeof fn}' with value: '${stringify(fn)}'. More on using Includer: https://git.io/JqcMn`);
-}

package/lib/merge-visitors.js

@@ -6,6 +6,7 @@ const {generate} = require('@putout/engine-parser');
 const runFix = require('./run-fix');
 const {getPosition} = require('./get-position');
 const maybeArray = require('./maybe-array');
+const {validate} = require('./validate');
 
 const {
     listStore,
@@ -23,8 +24,10 @@ const {assign} = Object;
 const parse = (name, plugin, options) => {
     const list = [];
     
-    if (plugin[name])
+    if (plugin[name]) {
+        validate(name, plugin[name]);
         list.push(...maybeArray(plugin[name]()));
+    }
     
     if (options[name])
         list.push(...maybeArray(options[name]));

package/lib/progress.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const {EventEmitter} = require('events');
+const {EventEmitter} = require('node:events');
 
 module.exports.createProgress = () => {
     let pluginsCount = 0;

package/lib/replace/index.js

@@ -119,13 +119,15 @@ const fix = (from, to, path) => {
     const waysTo = findVarsWays(nodeTo);
     const newPath = replaceWith(path, nodeTo);
     
-    validateTemplateValues(waysTo, waysFrom);
-    
-    setValues({
-        waysTo,
-        values,
-        path: newPath,
-    });
+    if (!nodeTo.__putout_replace_cooked) {
+        validateTemplateValues(waysTo, waysFrom);
+        
+        setValues({
+            waysTo,
+            values,
+            path: newPath,
+        });
+    }
     
     mark.add();
     path
@@ -174,8 +176,10 @@ function parseTo(to, values, path) {
     if (!toStr)
         return null;
     
-    if (isObj(toStr) && toStr.type)
+    if (isObj(toStr) && toStr.type) {
+        toStr.__putout_replace_cooked = true;
         return toStr;
+    }
     
     if (!isString(toStr))
         throw Error(`☝️ Looks like you passed 'replace' value with a wrong type. Allowed: 'string', 'node' and 'path'. Received: '${typeof toStr}' with value '${toStr}'.`);

package/lib/run-fix.js

@@ -16,9 +16,11 @@ const chooseFixArgs = ({path, pathOptions, options}) => {
                 options,
             }];
     
-    return [path, {
-        options,
-    }];
+    return [
+        path, {
+            options,
+        },
+    ];
 };
 
 const tryToFix = (fix, {path, pathOptions, position, options}) => {

package/lib/validate.js

@@ -0,0 +1,9 @@
+'use strict';
+
+const isFn = (a) => typeof a === 'function';
+const {stringify} = JSON;
+
+module.exports.validate = (name, fn) => {
+    if (!isFn(fn))
+        throw Error(`☝️ Looks like '${name}' is not a 'function' but '${typeof fn}' with value: '${stringify(fn)}'. More on using Includer: https://git.io/JqcMn`);
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@putout/engine-runner",
-  "version": "21.0.3",
+  "version": "21.2.0",
   "type": "commonjs",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "Run 🐊Putout plugins",
@@ -50,11 +50,11 @@
   ],
   "devDependencies": {
     "@putout/plugin-minify": "*",
-    "c8": "^9.0.0",
+    "c8": "^10.0.0",
     "eslint": "^9.0.0",
     "eslint-plugin-n": "^17.0.0",
-    "eslint-plugin-putout": "^22.0.0",
-    "just-camel-case": "^4.0.2",
+    "eslint-plugin-putout": "^23.0.0",
+    "just-camel-case": "^6.2.0",
     "lerna": "^6.0.1",
     "madrun": "^10.0.0",
     "mock-require": "^3.0.3",