@putout/engine-runner 14.1.0 → 15.0.0

package/README.md

@@ -15,15 +15,28 @@ npm i @putout/engine-runner
 
 There is a couple plugin types supported by 🐊**Putout**:
 
-- ✅[**Replacer**](#replacer)
-- ✅[**Includer**](#includer)
-- ✅[**Traverser**](#traverser)
-- ✅[**Finder**](#finder)
+- ✅ [**Declarator**](#Declarator)
+- ✅ [**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).
 
 They goes from simplest to hardest. Let's start from **Replacer**.
 
+### Declarator
+
+The simplest possible type of plugin, even simpler then `Replacer`:
+
+```js
+module.exports.declare = () => ({
+    isString: `const isString = (a) => typeof a === 'string'`,
+});
+```
+
+Based on [`@putout/operator-declare`](https://github.com/coderaiser/putout/tree/master/packages/operator-declare#readme), helps to add declaration to any referenced `Identifier`.
+
 ### Replacer
 
 **Replacer** converts code in declarative way. Simplest possible form, no need to use `fix`. Just `from` and `to` parts
@@ -219,7 +232,7 @@ module.exports.find = (ast, {push, traverse}) => {
 
 ```js
 const {runPlugins} = require('@putout/engine-runner');
-const {parse} = require('@putout/engin-parser');
+const {parse} = require('@putout/engine-parser');
 
 const plugins = [{
     rule: 'remove-debugger',
@@ -248,11 +261,11 @@ const places = runPlugins({
 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:
 
-- ✅`listStore`;
-- ✅`pathStore`;
-- ✅`store`;
-- ✅`upstore`;
-- ✅`uplist`;
+- ✅ [`listStore`](#liststore);
+- ✅ [`pathStore`](#pathstore);
+- ✅ [`store`](#store);
+- ✅ [`upstore`](#upstore);
+- ✅ [`uplist`](#uplist);
 
 Let's talk about each of them.
 

package/lib/declare.js

@@ -0,0 +1,23 @@
+'use strict';
+
+const {declare} = require('@putout/operator-declare');
+
+const {stringify} = JSON;
+const isFn = (a) => typeof a === 'function';
+
+module.exports = ({rule, plugin, msg, options}) => {
+    validateDeclare(plugin.declare);
+    
+    return {
+        rule,
+        plugin: declare(plugin.declare()),
+        msg,
+        options,
+    };
+};
+
+function validateDeclare(declare) {
+    if (!isFn(declare))
+        throw Error(`☝️ Looks like 'declare' property value is not a 'function', but '${typeof declare}' with value '${stringify(declare)}'.`);
+}
+

package/lib/index.js

@@ -9,6 +9,7 @@ const mergeVisitors = require('./merge-visitors');
 const superFind = require('./super-find');
 const include = require('./include');
 const replace = require('./replace');
+const declare = require('./declare');
 
 const {
     getPath,
@@ -50,8 +51,17 @@ module.exports.getPosition = getPosition;
 
 function run({ast, fix, shebang, pluginsFind, pluginsTraverse, template, merge}) {
     return [
-        ...runWithoutMerge({ast, fix, shebang, template, pluginsFind}),
-        ...runWithMerge({ast, fix, shebang, template, pluginsTraverse, merge}),
+        ...runWithoutMerge({ast,
+            fix,
+            shebang,
+            template,
+            pluginsFind}),
+        ...runWithMerge({ast,
+            fix,
+            shebang,
+            template,
+            pluginsTraverse,
+            merge}),
     ];
 }
 
@@ -152,6 +162,11 @@ function splitPlugins(plugins) {
             continue;
         }
         
+        if (plugin.declare) {
+            pluginsTraverse.push(include(declare(item)));
+            continue;
+        }
+        
         if (plugin.include) {
             pluginsTraverse.push(include(item));
             continue;

package/lib/maybe-array.js

@@ -1,11 +1,12 @@
 'use strict';
 
 const {isArray} = Array;
+const maybeArray = (a) => isArray(a) ? a : [a];
 
 module.exports = (a) => {
     if (!a)
         return [];
     
-    return isArray(a) ? a : [a];
+    return maybeArray(a);
 };
 

package/package.json

@@ -1,12 +1,11 @@
 {
   "name": "@putout/engine-runner",
-  "version": "14.1.0",
+  "version": "15.0.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",
-  "commitType": "colon",
   "release": false,
   "tag": false,
   "changelog": false,
@@ -30,6 +29,7 @@
     "@putout/compare": "^9.0.0",
     "@putout/engine-parser": "^5.0.0",
     "@putout/operate": "^8.0.0",
+    "@putout/operator-declare": "^4.6.5",
     "debug": "^4.1.1",
     "jessy": "^3.0.0",
     "nessy": "^4.0.0",