Code Monkey home page Code Monkey logo

dependency-packer-webpack-plugin's Introduction

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/

dependency-packer-webpack-plugin's People

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.