Implement Yarn 2 support

packages/eslint/README.md

@@ -186,6 +186,58 @@ The following is a list of rules and their identifiers which can be overridden:
 | ------ | ------------------------------------------------------------------------------------------------------------------------------- | -------- |
 | `lint` | By default, lints JS and JSX files from the `src` and `test` directories using ESLint. Contains a single loader named `eslint`. | all      |
 
+## Utility functions
+
+### Plugins aliasing
+
+When developing your custom ESLint preset, you may face a problem with sharable ESLint configs and plugins. This is due to ESLint plugins resolving system which searches for plugins packages in the project root. This may fail in some environments, especially in Plug'n'Play. This module provides `aliasPlugins()` function to resolve this issue in your package. You can import it in 2 ways: `require('@neutrinojs/eslint/alias-plugins')` or `require('@neutrinojs/eslint').aliasPlugins`. Example:
+
+```js
+const eslint = require('@neutrinojs/eslint');
+const eslintBaseConfig = { plugins: ['node'] };
+
+neutrino.use(eslint({
+  eslint: {
+    baseConfig: eslintBaseConfig
+  }
+}))
+
+lint.aliasPlugins(
+  // ESLint config that contains used plugins
+  eslintBaseConfig,
+  // Path to the current module file, so aliases can be correctly resolved relative to your package
+  // In most cases it is always `__filename`
+  __filename
+);
+```
+
+If you use 3rd party configs, plugins will not be present in the configuration. So you have to list them manually just for aliasing. For example:
+
+```js
+const eslint = require('@neutrinojs/eslint');
+const usedPlugins = ['react', 'react-hooks', 'jsx-a11y', 'import'];
+const eslintBaseConfig = {
+  extends: [
+    require.resolve('eslint-config-airbnb'),
+    require.resolve('eslint-config-airbnb/hooks')
+  ]
+};
+
+neutrino.use(eslint({
+  eslint: {
+    baseConfig: eslintBaseConfig
+  }
+}))
+
+lint.aliasPlugins(
+  // ESLint config that contains only used plugins
+  { plugins: usedPlugins },
+  // Path to the current module file, so aliases can be correctly resolved relative to your package
+  // In most cases it is always `__filename`
+  __filename
+);
+```
+
 ## Contributing
 
 This middleware is part of the

packages/eslint/alias-plugins.js

@@ -0,0 +1,41 @@
+const moduleAlias = require('module-alias');
+const pnpApi = process.versions.pnp ? require('pnpapi') : null; // eslint-disable-line import/no-unresolved
+
+function toFullName(pluginName) {
+  const ESLINT_PREFIX = 'eslint-plugin-';
+  const ORGANIZATION_EXPRESSION = /^(@[\d.A-z-]+)\/(.+)$/;
+  const nameIsFull = pluginName.indexOf(ESLINT_PREFIX) === 0;
+  const nameIsOrganization = ORGANIZATION_EXPRESSION.test(pluginName);
+
+  if (nameIsOrganization) {
+    const [, organizationName, name] = pluginName.match(
+      ORGANIZATION_EXPRESSION,
+    );
+
+    return `${organizationName}/${toFullName(name)}`;
+  }
+
+  return nameIsFull ? pluginName : `${ESLINT_PREFIX}${pluginName}`;
+}
+
+function aliasModuleFrom(relativeFilename = __filename) {
+  return function aliasPlugin(pluginName) {
+    let resolvedPluginPath;
+
+    if (pnpApi) {
+      resolvedPluginPath = pnpApi.resolveRequest(pluginName, relativeFilename);
+    } else {
+      resolvedPluginPath = require.resolve(pluginName, {
+        paths: [relativeFilename],
+      });
+    }
+
+    moduleAlias.addAlias(pluginName, resolvedPluginPath);
+  };
+}
+
+module.exports = function aliasPlugins(eslintConfig, relativeFilename) {
+  const { plugins = [] } = eslintConfig;
+
+  plugins.map(toFullName).forEach(aliasModuleFrom(relativeFilename));
+};

packages/eslint/index.js

@@ -1,4 +1,5 @@
 const { ConfigurationError, DuplicateRuleError } = require('neutrino/errors');
+const aliasPlugins = require('./alias-plugins');
 
 const arrayToObject = (array) =>
   array.reduce((obj, item) => Object.assign(obj, { [item]: true }), {});
@@ -125,7 +126,7 @@ module.exports = ({ test, include, exclude, eslint = {} } = {}) => {
     }
 
     const baseConfig = eslint.baseConfig || {};
-
+    const usedPlugins = ['babel'];
     const loaderOptions = {
       // For supported options, see:
       // https://github.com/webpack-contrib/eslint-loader#options
@@ -172,10 +173,12 @@ module.exports = ({ test, include, exclude, eslint = {} } = {}) => {
             // Unfortunately we can't `require.resolve('eslint-plugin-babel')` due to:
             // https://github.com/eslint/eslint/issues/6237
             // ...so we have no choice but to rely on it being hoisted.
-            plugins: ['babel', ...(baseConfig.plugins || [])],
+            plugins: [...usedPlugins, ...(baseConfig.plugins || [])],
           },
     };
 
+    aliasPlugins({ plugins: usedPlugins });
+
     neutrino.config.module
       .rule('lint')
       .test(test || neutrino.regexFromExtensions())
@@ -192,3 +195,5 @@ module.exports = ({ test, include, exclude, eslint = {} } = {}) => {
     neutrino.register('eslintrc', eslintrc);
   };
 };
+
+module.exports.aliasPlugins = aliasPlugins;

packages/eslint/package.json

@@ -29,7 +29,8 @@
   "dependencies": {
     "babel-eslint": "^10.1.0",
     "eslint-loader": "^4.0.2",
-    "eslint-plugin-babel": "^5.3.1"
+    "eslint-plugin-babel": "^5.3.1",
+    "module-alias": "^2.2.2"
   },
   "peerDependencies": {
     "eslint": "^6.0.0 || ^7.0.0",

yarn.lock

@@ -10231,7 +10231,7 @@ modify-values@^1.0.0:
   resolved "https://registry.yarnpkg.com/modify-values/-/modify-values-1.0.1.tgz#b3939fa605546474e3e3e3c63d64bd43b4ee6022"
   integrity sha512-xV2bxeN6F7oYjZWTe/YPAy6MN2M+sL4u/Rlm2AHCIVGfo2p1yGmBHQ6vHehl4bRTZBdHu3TSkWdYgkwpYzAGSw==
 
-[email protected]:
+[email protected], module-alias@^2.2.2:
   version "2.2.2"
   resolved "https://registry.yarnpkg.com/module-alias/-/module-alias-2.2.2.tgz#151cdcecc24e25739ff0aa6e51e1c5716974c0e0"
   integrity sha512-A/78XjoX2EmNvppVWEhM2oGk3x4lLxnkEA4jTbaK97QKSDjkIoOsKQlfylt/d3kKKi596Qy3NP5XrXJ6fZIC9Q==