@putout/engine-loader 4.10.0 → 5.1.0

package/README.md

@@ -3,7 +3,7 @@
 [NPMIMGURL]: https://img.shields.io/npm/v/@putout/engine-loader.svg?style=flat&longCache=true
 [NPMURL]: https://npmjs.org/package/@putout/engine-loader"npm"
 
-Load putout `plugins`, `processors`.
+Load 🐊[`Putout`](https://github.com/coderaiser/putout) `Plugins` and `Processors`.
 
 ## Install
 
@@ -11,6 +11,11 @@ Load putout `plugins`, `processors`.
 npm i @putout/engine-loader
 ```
 
+## Env Variables
+
+When you need to get things working with Yarn PnP, and using custom `plugins` `formatters` or `processers`, add env variable
+`PUTOUT_YARN_PNP` with name of a package that contains dependencies you need.
+
 ## Code Example
 
 ### loadPlugins
@@ -33,25 +38,6 @@ const plugins = loadPlugins({
 });
 ```
 
-#### JSCodeshift
-
-`@putout/engine-loader` supports loading transforms written for [jscodeshift](https://github.com/facebook/jscodeshift) with help of prefix `jscodeshift/`.
-
-```js
-const pluginNames = [
-    'jscodeshift/async-await-codemod',
-];
-
-const rules = {
-    'jscodeshift/async-await-codemod': ['on', 'any message you like :)'],
-};
-
-const plugins = loadPlugins({
-    pluginNames,
-    rules, // optional
-});
-```
-
 #### Babel Plugins
 
 You can use `babel plugins` with help of `babel/` prefix.

package/lib/index.js

@@ -120,8 +120,7 @@ function getLoadedRules(rules) {
 
 function splitRule(rule) {
     const name = rule
-        .replace('babel/', '')
-        .replace('jscodeshift/', '');
+        .replace('babel/', '');
     
     if (/^babel/.test(rule))
         return [
@@ -129,12 +128,6 @@ function splitRule(rule) {
             'babel',
         ];
     
-    if (/^jscodeshift/.test(rule))
-        return [
-            name,
-            'jscodeshift',
-        ];
-    
     return [
         name,
         'putout',

package/lib/load.js

@@ -1,37 +1,19 @@
 'use strict';
 
 const {createRequire} = require('module');
+
 const tryCatch = require('try-catch');
+const once = require('once');
 
 const wrapPlugin = require('./wrap-plugin');
 
-// yarn PnP API
-// https://yarnpkg.com/advanced/rulebook#modules-shouldnt-hardcode-node_modules-paths-to-access-other-modules
-const customRequire = createRequire(__filename);
 const bigFirst = (a) => `${a[0].toUpperCase()}${a.slice(1)}`;
 
-const getModulePath = (name) => {
-    const [, path] = tryCatch(customRequire.resolve, name);
-    return path;
-};
-
-function getPath(namespace, type, name) {
-    let path = getModulePath(`@${namespace}/${type}-${name}`);
-    
-    if (!path)
-        path = getModulePath(`${namespace}-${type}-${name}`);
-    
-    if (!path)
-        path = getModulePath(name);
-    
-    return path;
-}
-
 const load = (type) => ({name, namespace}) => {
     if (namespace !== 'putout')
         return wrapPlugin(name, namespace);
     
-    const pluginPath = getPath(namespace, type, name);
+    const [pluginPath, customRequire] = getPath(namespace, type, name);
     
     if (!pluginPath)
         throw Error(`${bigFirst(type)} "${namespace}-${type}-${name}" could not be found!`);
@@ -42,3 +24,43 @@ const load = (type) => ({name, namespace}) => {
 module.exports.loadPlugin = load('plugin');
 module.exports.loadProcessor = load('processor');
 
+function getPath(namespace, type, name) {
+    let [path, customRequire] = getModulePath(`@${namespace}/${type}-${name}`);
+    
+    if (!path)
+        [path, customRequire] = getModulePath(`${namespace}-${type}-${name}`);
+    
+    if (!path)
+        [path, customRequire] = getModulePath(name);
+    
+    return [path, customRequire];
+}
+
+const {PUTOUT_YARN_PNP = 'putout'} = process.env;
+
+const createCustomRequire = once(() => createRequire(require.resolve(PUTOUT_YARN_PNP)));
+const createPutoutRequire = once(() => createRequire(require.resolve('putout')));
+
+// That's all for Yarn P'n'P
+//
+// We need to create a couple version of require for plugins, formatters and processors:
+// - declared in 🐊Putout package.json;
+// - declared in module that want to extend 🐊Putout;
+//
+// https://yarnpkg.com/advanced/rulebook#modules-shouldnt-hardcode-node_modules-paths-to-access-other-modules
+function getModulePath(name) {
+    let path;
+    
+    const customRequire = createCustomRequire();
+    const putoutRequire = createPutoutRequire();
+    
+    [, path] = tryCatch(putoutRequire.resolve, name);
+    
+    if (path)
+        return [path, putoutRequire];
+    
+    [, path] = tryCatch(customRequire.resolve, name);
+    
+    return [path, customRequire];
+}
+

package/lib/parse-rules.js

@@ -130,7 +130,7 @@ function validateState(rule, value) {
 }
 
 const cut = (a) => a.split('/')[0];
-const isExclude = (a) => a.includes('babel') || a.includes('jscodeshift');
+const isExclude = (a) => a.includes('babel');
 
 function parseSubrules(rules) {
     const newRules = {};

package/lib/validate-plugin.js

@@ -17,6 +17,6 @@ module.exports = ({plugin, rule}) => {
             return;
     }
     
-    throw Error(`☝️ Plugin "${rule}" type cannot be determined. Supported plugin types: https://git.io/JqcMn`);
+    throw Error(`☝️ Cannot determine type of plugin '${rule}'. Here is list of supported plugins: https://git.io/JqcMn`);
 };
 

package/lib/validate-rules.js

@@ -1,7 +1,7 @@
 'use strict';
 
 const parse = (rule) => {
-    if (/^(babel|jscodeshift)\//.test(rule))
+    if (/^babel\//.test(rule))
         return rule;
     
     if (rule.includes('/'))

package/lib/wrap-plugin.js

@@ -6,7 +6,6 @@ const {print} = require('@putout/engine-parser');
 const getPositions = require('./get-positions-by-diff');
 
 const babelTransform = require('./transforms/babel');
-const jscodeshiftTransform = require('./transforms/jscodeshift');
 
 const getMessage = (a) => a
     .replace(/@babel\/plugin-|babel-plugin-/, '')
@@ -27,13 +26,6 @@ module.exports = (name, namespace) => {
             transform: babelTransform,
         });
     
-    if (/jscodeshift/.test(namespace))
-        return getPlugin({
-            name,
-            message,
-            transform: jscodeshiftTransform,
-        });
-    
     return null;
 };
 

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@putout/engine-loader",
-  "version": "4.10.0",
+  "version": "5.1.0",
+  "type": "commonjs",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "load plugins and prepare them to run",
-  "homepage": "https://github.com/coderaiser/putout/tree/master/packages/engine-loader",
+  "homepage": "https://github.com/coderaiser/putout/tree/master/packages/engine-loader#readme",
   "main": "lib/index.js",
   "release": false,
   "tag": false,
@@ -26,7 +27,6 @@
     "@babel/core": "^7.12.3",
     "@putout/engine-parser": "^4.0.1",
     "diff-match-patch": "^1.0.4",
-    "jscodeshift": "^0.13.0",
     "nano-memoize": "^1.1.8",
     "once": "^1.4.0",
     "try-catch": "^3.0.0"
@@ -41,14 +41,13 @@
     "@cloudcmd/stub": "^3.0.0",
     "@putout/plugin-convert-commonjs-to-esm": "*",
     "@putout/plugin-remove-unused-variables": "*",
-    "@putout/processor-markdown": "*",
     "@putout/processor-javascript": "*",
+    "@putout/processor-markdown": "*",
     "c8": "^7.5.0",
     "eslint": "^8.0.1",
     "eslint-plugin-node": "^11.0.0",
-    "eslint-plugin-putout": "^12.0.0",
+    "eslint-plugin-putout": "^13.0.0",
     "estrace": "^3.0.2",
-    "js-codemod": "^7.0.0",
     "just-camel-case": "^4.0.2",
     "lerna": "^4.0.0",
     "madrun": "^8.0.1",

package/lib/transforms/jscodeshift.js

@@ -1,42 +0,0 @@
-'use strict';
-
-const once = require('once');
-
-const {print} = require('@putout/engine-parser');
-const {assign} = Object;
-
-const isStr = (a) => typeof a === 'string';
-
-const printAST = (a) => isStr(a) ? a : print(a);
-const getFn = (fn) => (...args) => {
-    return printAST(fn(...args));
-};
-
-const getJScodeshift = once(() => require('jscodeshift'));
-
-const wrapCodeShift = (ast) => {
-    const j = getJScodeshift();
-    const avoidPrint = {
-        toSource() {},
-    };
-    
-    let isCalled = false;
-    const fixedJscodeshift = (a) => {
-        if (isCalled)
-            return j(a);
-        
-        isCalled = true;
-        return assign(j(ast), avoidPrint);
-    };
-    
-    return assign(fixedJscodeshift, j);
-};
-
-module.exports = (ast, source, pluginName) => {
-    const jscodeshift = wrapCodeShift(ast);
-    const fn = getFn(require(pluginName));
-    const options = {};
-    
-    fn({source}, {jscodeshift}, options);
-};
-