@putout/engine-runner 13.0.1 → 13.1.0

package/README.md

@@ -3,7 +3,7 @@
 [NPMIMGURL]: https://img.shields.io/npm/v/@putout/engine-runner.svg?style=flat&longCache=true
 [NPMURL]: https://npmjs.org/package/@putout/engine-runner"npm"
 
-Run 🐊[`Putout`](https://github.com/coderaiser/putout) plugins.
+Run 🐊[**Putout**](https://github.com/coderaiser/putout) plugins.
 
 ## Install
 
@@ -13,20 +13,20 @@ npm i @putout/engine-runner
 
 ## Supported Plugin Types
 
-There is a couple plugin types supported by 🐊`Putout`:
+There is a couple plugin types supported by 🐊**Putout**:
 
 - ✅[`Replacer`](#replacer)
 - ✅[`Includer`](#includer)
 - ✅[`Traverser`](#traverser)
 - ✅[`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).
+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).
 
-They goes from simplest to hardest. Let's start from `Replacer`.
+They goes from simplest to hardest. Let's start from **Replacer**.
 
 ### 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, 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:
@@ -63,7 +63,7 @@ Simplest remove example:
 module.exports.report = () => 'debugger should not be used';
 
 module.exports.replace = () => ({
-    'debugger': '',
+    debugger: '',
 });
 ```
 
@@ -210,8 +210,8 @@ const {runPlugins} = require('@putout/engine-runner');
 const {parse} = require('@putout/engin-parser');
 
 const plugins = [{
-    rule: "remove-debugger",
-    msg: "",        // optional
+    rule: 'remove-debugger',
+    msg: '',        // optional
     options: {},    // optional
     plugin: {
         include: () => ['debugger'],
@@ -233,7 +233,7 @@ const places = runPlugins({
 
 ## Stores
 
-Stores is preferred way of keeping 🐊`Putout` data, `traverse` init function called only once, and any other way
+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 3 store types:
 
 - ✅`listStore`;

package/lib/include.js

@@ -17,8 +17,8 @@ module.exports = ({rule, plugin, msg, options}) => {
         filter = good,
     } = plugin;
     
-    if (!isFn(include))
-        throw Error(`☝️ Looks like "include" is not a function: ${stringify(include)}. More on using Includer: https://git.io/JqcMn`);
+    validate('include', include);
+    validate('report', report);
     
     const traverse = getTraverse(include(), filter, rule);
     
@@ -64,3 +64,7 @@ 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/run-fix.js

@@ -3,6 +3,8 @@
 const tryCatch = require('try-catch');
 const debug = require('debug')('putout:runner:fix');
 const {enabled} = debug;
+const {stringify} = JSON;
+const isFn = (a) => typeof a === 'function';
 
 const tryToFix = (fix, {path, position, options}) => {
     const [e] = tryCatch(fix, path, {options});
@@ -25,6 +27,7 @@ module.exports = (is, fix, {path, rule, position, options}) => {
         return;
     
     enabled && debug(`fix: ${rule}`, position, path.toString());
+    validate('fix', fix);
     
     tryToFix(fix, {
         path,
@@ -33,3 +36,8 @@ module.exports = (is, fix, {path, rule, position, options}) => {
     });
 };
 
+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 writing 🐊Putout Plugins: https://git.io/JqcMn`);
+}
+

package/package.json

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