rebuild-changed-entrypoints-webpack-plugin

Webpack plugin that takes care of only rebuilding entrypoints that include changed files.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
rebuild-changed-entrypoints-webpack-plugin
311.0.15 years ago5 years agoMinified + gzip package size for rebuild-changed-entrypoints-webpack-plugin in KB

Readme

<img width="200" height="200" vspace="" hspace="25"
  src="https://cdn.rawgit.com/webpack/media/e7485eb2/logo/icon.svg">
Rebuild-Changed-Entrypoints-Webpack-Plugin

A webpack plugin that makes webpack only build entrypoints with changed files/dependencies (therefore, skipping entrypoints with no changes).

Install

yarn add -D rebuild-changed-entrypoints-webpack-plugin

npm install rebuild-changed-entrypoints-webpack-plugin --save-dev

Usage

const RebuildChangedPlugin = require('rebuild-changed-entrypoints-webpack-plugin');

// Webpack configuration
module.exports = {
  //...
  plugins: [
    new RebuildChangedPlugin({
      cacheDirectory: __dirname,
    }),
  ],
  //...
};

Options

There are some options you can pass to modify the behavior of the plugin.
| Attribute | Type | Required | Description | | ---------------- | ------------------------------ | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | cacheDirectory | {String} | True | Specifies the path, where the cache directory .webpack-changed-plugin-cache will be generated | | logLevel | {"none" \| "error" \| "debug"} | False - default: "none" | Specifies the logLevel for the console output.
"none" - No logging
"error" - Only error logs
"debug" - Prints very detailed information about the process |
webpack.config.js
plugins: [
    new RebuildChangedPlugin({
      cacheDirectory: __dirname,
    }),
  ],

How it works

(1) Build up Cache
The plugin hooks into the webpack compilation process. So, after the dependency tree is build, we cache the corresponding dependencies of every entrypoint and their last modification dates by writing this information to a JSON.
(2) Use cache to determine rebuild targets
When webpack tries to rebuild an entrypoint, we check whether the cache holds information for that entry. If there is information and neither a dependenciy from nor the entrypoint itself changed, it is skipped.
No magic :)

Motivation

This plugin was written to speed up the build process for the development setup in a gulp environment. For development we use gulp.watch to rebuild according files. However, the watcher does not know about entrypoints and their corresponding dependencies.
However, there might be other use cases, where this plugin makes sense.
This plugin probably does not make sense, when you use the webpack-dev-server.