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",

packages/jest/src/index.js

@@ -39,9 +39,7 @@ module.exports = (options = {}) => (neutrino) => {
         return path;
       }
 
-      return path.startsWith('.')
-        ? join('<rootDir>', path)
-        : join('<rootDir>', 'node_modules', path);
+      return path.startsWith('.') ? join('<rootDir>', path) : path;
     };
     const extensionsToNames = (extensions) => `\\.(${extensions.join('|')})$`;
     const { extensions, source, tests, root, debug } = neutrino.options;

packages/jest/test/jest_test.js

@@ -160,7 +160,7 @@ test('exposes babel config without babel-loader specific options', (t) => {
   t.false('customize' in babelOptions);
 });
 
-test('configures webpack aliases in moduleNameMapper correctly', (t) => {
+test('configures absolute webpack aliases in moduleNameMapper correctly', (t) => {
   const api = new Neutrino();
   const reactPath = path.resolve(path.join('node_modules', 'react'));
   api.use(reactPreset());
@@ -174,3 +174,30 @@ test('configures webpack aliases in moduleNameMapper correctly', (t) => {
     }),
   );
 });
+
+test('configures package webpack aliases in moduleNameMapper correctly', (t) => {
+  const api = new Neutrino();
+  api.use(mw());
+  api.config.resolve.alias.set('_', 'lodash');
+  const config = api.outputHandlers.get('jest')(api);
+
+  t.true(
+    Object.entries(config.moduleNameMapper).some(([key, alias]) => {
+      return key === '^_$' && alias === 'lodash';
+    }),
+  );
+});
+
+test('configures relative webpack aliases in moduleNameMapper correctly', (t) => {
+  const api = new Neutrino();
+  api.use(mw());
+  api.config.resolve.alias.set('images', './src/images');
+  const config = api.outputHandlers.get('jest')(api);
+
+  t.true(
+    Object.entries(config.moduleNameMapper).some(([key, alias]) => {
+      const urlAlias = alias.replace(/\\/g, '/'); // consider OS difference
+      return key === '^images$' && urlAlias === '<rootDir>/src/images';
+    }),
+  );
+});

packages/library/index.js

@@ -1,6 +1,7 @@
 const banner = require('@neutrinojs/banner');
 const compileLoader = require('@neutrinojs/compile-loader');
 const clean = require('@neutrinojs/clean');
+const pnp = require('@neutrinojs/pnp');
 const babelMerge = require('babel-merge');
 const merge = require('deepmerge');
 const nodeExternals = require('webpack-node-externals');
@@ -63,6 +64,7 @@ module.exports = (opts = {}) => {
       (pkg.dependencies && 'source-map-support' in pkg.dependencies) ||
       (pkg.devDependencies && 'source-map-support' in pkg.devDependencies);
 
+    neutrino.use(pnp());
     neutrino.use(
       compileLoader({
         include: [neutrino.options.source, neutrino.options.tests],

packages/library/package.json

@@ -40,6 +40,7 @@
     "@neutrinojs/banner": "9.4.0",
     "@neutrinojs/clean": "9.4.0",
     "@neutrinojs/compile-loader": "9.4.0",
+    "@neutrinojs/pnp": "9.4.0",
     "babel-merge": "^3.0.0",
     "deepmerge": "^1.5.2",
     "webpack-node-externals": "^1.7.2"

packages/node/index.js

@@ -2,6 +2,7 @@ const banner = require('@neutrinojs/banner');
 const compileLoader = require('@neutrinojs/compile-loader');
 const clean = require('@neutrinojs/clean');
 const startServer = require('@neutrinojs/start-server');
+const pnp = require('@neutrinojs/pnp');
 const babelMerge = require('babel-merge');
 const nodeExternals = require('webpack-node-externals');
 const { basename, parse, format } = require('path');
@@ -39,6 +40,7 @@ module.exports = (opts = {}) => {
     );
     const coreJsVersion = neutrino.getDependencyVersion('core-js');
 
+    neutrino.use(pnp());
     neutrino.use(
       compileLoader({
         include: [neutrino.options.source, neutrino.options.tests],

packages/node/package.json

@@ -33,6 +33,7 @@
     "@neutrinojs/banner": "9.4.0",
     "@neutrinojs/clean": "9.4.0",
     "@neutrinojs/compile-loader": "9.4.0",
+    "@neutrinojs/pnp": "9.4.0",
     "@neutrinojs/start-server": "9.4.0",
     "babel-merge": "^3.0.0",
     "deepmerge": "^1.5.2",

packages/pnp/.npmignore

@@ -0,0 +1 @@
+/test/

packages/pnp/README.md

@@ -0,0 +1,87 @@
+# Neutrino Plug'n'Play Middleware
+
+`@neutrinojs/pnp` is Neutrino middleware for Plug'n'Play support.
+
+[![NPM version][npm-image]][npm-url] [![NPM downloads][npm-downloads]][npm-url]
+
+## Requirements
+
+- Node.js 10+
+- Yarn v1.2.1+, or npm v5.4+
+- Neutrino 9
+- Webpack 4
+
+## Installation
+
+`@neutrinojs/pnp` can be installed via the Yarn or npm clients.
+
+#### Yarn
+
+```bash
+❯ yarn add --dev @neutrinojs/pnp
+```
+
+#### npm
+
+```bash
+❯ npm install --save-dev @neutrinojs/pnp
+```
+
+## Usage
+
+`@neutrinojs/pnp` can be consumed from the Neutrino API, middleware, or presets.
+Require this package and plug it into Neutrino:
+
+```js
+const pnp = require('@neutrinojs/pnp');
+
+// Use with default options
+neutrino.use(pnp());
+
+// Usage shows the default values of this middleware:
+neutrino.use(pnp({ pluginId: 'pnp' }));
+```
+
+```js
+// Using in .neutrinorc.js
+const pnp = require('@neutrinojs/pnp');
+
+// Use with default options
+module.exports = {
+  use: [pnp()],
+};
+
+// Usage shows the default values of this middleware:
+module.exports = {
+  use: [pnp({ pluginId: 'pnp' })],
+};
+```
+
+- `pluginId`: The plugin identifier. Override this to add an additional copy
+  plugin instance.
+
+## Customization
+
+`@neutrinojs/pnp` creates some conventions to make overriding the configuration
+easier once you are ready to make changes.
+
+### Plugins
+
+The following is a list of plugins and their identifiers which can be
+overridden:
+
+| Name  | Description                                               | NODE_ENV |
+| ----- | --------------------------------------------------------- | -------- |
+| `pnp` | Resolve modules considering Plug and Play feature of Yarn | all      |
+
+## Contributing
+
+This middleware is part of the
+[neutrino](https://github.com/neutrinojs/neutrino) repository, a monorepo
+containing all resources for developing Neutrino and its core presets and
+middleware. Follow the
+[contributing guide](https://neutrinojs.org/contributing/) for details.
+
+[npm-image]: https://img.shields.io/npm/v/@neutrinojs/pnp.svg
+[npm-downloads]: https://img.shields.io/npm/dt/@neutrinojs/pnp.svg
+[npm-url]: https://www.npmjs.com/package/@neutrinojs/pnp

packages/pnp/index.js

@@ -0,0 +1,41 @@
+const moduleAlias = require('module-alias');
+
+module.exports = function pnp(settings = {}) {
+  return function pnpMiddleware(neutrino) {
+    const { pluginId = 'pnp' } = settings;
+    const projectPath = process.cwd();
+    const environmentIsPnP = Boolean(process.versions.pnp);
+
+    if (environmentIsPnP) {
+      // solve the issue with the linked middleware outside of the project root
+      // https://github.com/yarnpkg/berry/issues/693
+      moduleAlias.addAlias(
+        'pnpapi',
+        require.resolve('pnpapi', { paths: [projectPath] }),
+      );
+    }
+
+    // eslint-disable-next-line global-require -- Have to import this after `require` alias is applied
+    const PnpWebpackPlugin = require(`pnp-webpack-plugin`);
+
+    function PnpPlugin() {
+      return PnpWebpackPlugin;
+    }
+    function PnpLoaderPlugin() {
+      return PnpWebpackPlugin.moduleLoader(module);
+    }
+
+    /* eslint-disable prettier/prettier */
+     neutrino.config
+      .resolve
+        .plugin(pluginId)
+          .use(PnpPlugin)
+          .end()
+        .end()
+      .resolveLoader
+        .plugin(pluginId)
+          .use(PnpLoaderPlugin)
+          .end()
+        .end();
+  };
+};