Skip to content

Latest commit

 

History

History
97 lines (75 loc) · 3.98 KB

README.md

File metadata and controls

97 lines (75 loc) · 3.98 KB
Raw

Plug'n'Play resolver for Webpack

npm version node version

This plugin is also available for Jest (jest-pnp-resolver), Rollup (rollup-plugin-pnp-resolve), and TypeScript (ts-pnp)

Installation

yarn add -D pnp-webpack-plugin

Usage

Simply add the plugin to both the resolver and resolveLoader:

const PnpWebpackPlugin = require(`pnp-webpack-plugin`);

module.exports = {
  resolve: {
    plugins: [
      PnpWebpackPlugin,
    ],
  },
  resolveLoader: {
    plugins: [
      PnpWebpackPlugin.moduleLoader(module),
    ],
  },
};

The resolve entry will take care of correctly resolving the dependencies required by your program, and the resolveLoader entry will help Webpack find the location of the loaders on the disk. Note that in this case, all loaders will be resolved relative to the package containing your configuration.

In case part of your configuration comes from third-party packages that use their own loaders, make sure they use require.resolve - this will ensure that the resolution process is portable accross environments (including when Plug'n'Play isn't enabled), and prevent it from relying on undefined behaviors:

module.exports = {
  module: {
    rules: [{
      test: /\.js$/,
      loader: require.resolve('babel-loader'),
    }]
  },
};

ts-loader integration

This plugin as an integration to easily add support for TypeScript in your applications through ts-loader. In order to do this, just do the following:

const PnpWebpackPlugin = require(`pnp-webpack-plugin`);

module.exports = {
  module: {
    rules: [{
      test: /\.ts$/,
      loader: require.resolve('ts-loader'),
      options: PnpWebpackPlugin.tsLoaderOptions({
        // ... regular options go there ...
      }),
    }],
  },
};

If you have any options you want to pass to ts-loader, just pass them as parameter of the tsLoaderOptions function and it will take care of forwarding them properly.

fork-ts-checker-webpack-plugin integration

We also provide an integration for fork-ts-checker-webpack-plugin, in a similar way to what we do with ts-loader. Here's an example:

const ForkTsCheckerWebpackPlugin = require(`fork-ts-checker-webpack-plugin`);
const PnpWebpackPlugin = require(`pnp-webpack-plugin`);

module.exports = {
  plugins: [
    new ForkTsCheckerWebpackPlugin(PnpWebpackPlugin.forkTsCheckerOptions({
      // ... regular options go there ...
    }),
  ],
};

License (MIT)

Copyright © 2016 Maël Nison

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.