@putout/engine-loader 4.9.0 → 4.12.0

package/README.md

@@ -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

package/lib/is-enabled.js

@@ -2,11 +2,13 @@
 
 const {isArray} = Array;
 
+const isBool = (a) => typeof a === 'boolean';
+
 module.exports = (name, rules) => {
     if (isArray(name))
         [name] = name;
     
-    if (typeof rules[name] === 'boolean')
+    if (isBool(rules[name]))
         return rules[name];
     
     let resultState = true;

package/lib/load.js

@@ -1,34 +1,66 @@
 'use strict';
 
+const {createRequire} = require('module');
+
+const tryCatch = require('try-catch');
+const once = require('once');
+
 const wrapPlugin = require('./wrap-plugin');
-const getModulePath = require('./get-module-path');
 
 const bigFirst = (a) => `${a[0].toUpperCase()}${a.slice(1)}`;
 
-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!`);
     
-    return require(pluginPath);
+    return customRequire(pluginPath);
 };
 
 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/wrap-plugin.js

@@ -1,8 +1,9 @@
 'use strict';
 
+const tryCatch = require('try-catch');
 const {print} = require('@putout/engine-parser');
+
 const getPositions = require('./get-positions-by-diff');
-const getModulePath = require('./get-module-path');
 
 const babelTransform = require('./transforms/babel');
 const jscodeshiftTransform = require('./transforms/jscodeshift');
@@ -11,6 +12,11 @@ const getMessage = (a) => a
     .replace(/@babel\/plugin-|babel-plugin-/, '')
     .replace(/-/g, ' ');
 
+const getModulePath = (name) => {
+    const [, path] = tryCatch(require.resolve, name);
+    return path;
+};
+
 module.exports = (name, namespace) => {
     const message = getMessage(name);
     

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@putout/engine-loader",
-  "version": "4.9.0",
+  "version": "4.12.0",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "load plugins and prepare them to run",
-  "homepage": "http://github.com/coderaiser/putout",
+  "homepage": "https://github.com/coderaiser/putout/tree/master/packages/engine-loader",
   "main": "lib/index.js",
   "release": false,
   "tag": false,
@@ -42,10 +42,11 @@
     "@putout/plugin-convert-commonjs-to-esm": "*",
     "@putout/plugin-remove-unused-variables": "*",
     "@putout/processor-markdown": "*",
+    "@putout/processor-javascript": "*",
     "c8": "^7.5.0",
     "eslint": "^8.0.1",
     "eslint-plugin-node": "^11.0.0",
-    "eslint-plugin-putout": "^11.0.0",
+    "eslint-plugin-putout": "^12.0.0",
     "estrace": "^3.0.2",
     "js-codemod": "^7.0.0",
     "just-camel-case": "^4.0.2",

package/lib/get-module-path.js

@@ -1,9 +0,0 @@
-'use strict';
-
-const tryCatch = require('try-catch');
-
-module.exports = (name) => {
-    const [, path] = tryCatch(require.resolve, name);
-    return path;
-};
-