Skip to content

Webpack plugin that packs dependencies for entrypoints individually.

Notifications You must be signed in to change notification settings

noverby/dependency-packer-webpack-plugin

 
 

Repository files navigation

Dependency Packer Webpack Plugin

https://travis-ci.com/martinjlowm/dependency-packer-webpack-plugin.svg?branch=master

A Webpack plugin that automatically packs dependencies for entry points individually for Node projects.

This does a similar job to Serverless Webpack, but instead of solely inspecting the project’s package.json (and being dependent on the Serverless project) - this plugin utilizes the Webpack compiler’s module hooks to determine exactly what dependencies are required.

This works perfectly with aws-cdk (and presumably similar projects), enabling direct asset references to the bundle:

const fun = new lambda.Function(this, 'lambdaFunction', {
  functionName: 'lambdaFunction',
  runtime: lambda.Runtime.NodeJS810,
  handler: 'fun.handler',                  // <-
  code: lambda.Code.asset('.webpack/fun'), // <-
});

Usage

First, install the plugin: [npm/yarn] install dependency-packer-webpack-plugin, then reference and add it to your Webpack config:

const DependencyPackerPlugin = require('dependency-packer-webpack-plugin').DependencyPackerPlugin;

module.exports = [{
  ...
  entry: {
    fun: 'fun.js',
  },
  output: {
    filename: '[name].js',
    path: '.webpack/<entry-name>',
  }
  ...
  plugins: [
    new DependencyPackerPlugin({ // Must be initialized per bundle
      blacklist: [/aws-sdk/], // Optional
      packageManager: 'npm'   // Optional
    }),
  ],
}]; // One config per entry point to initiate multiple compilers

For multiple entry points, each bundle must be output to its own directory to avoid conflicts during installation of dependencies. To do so, it’s recommended to export a list of configs, one for each entry point.

For practical examples see examples/.

Development

Use NPM/Yarn links to easily integrate the plugin in your project to test special cases that are not covered by the unit tests.

[npm run/yarn] build
[npm/yarn] link
cd <project-that-uses-this-plugin>
[npm/yarn] link dependency-packer-webpack-plugin

For convenience, the TypeScript config adds specific path prefixes to indicate relative paths of the src, dist and test directories:

  • @: src/
  • #: dist/
  • $: test/

About

Webpack plugin that packs dependencies for entrypoints individually.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 100.0%