Skip to content

Latest commit

 

History

History
61 lines (42 loc) · 1.71 KB

README.md

File metadata and controls

61 lines (42 loc) · 1.71 KB
Raw

webpack-chunk-manifest-plugin

Allows exporting a JSON file that maps chunk ids to their resulting asset files. Webpack can then read this mapping, assuming it is provided somehow on the client, instead of storing a mapping (with chunk asset hashes) in the bootstrap script, which allows to actually leverage long-term caching.

NPM

This repo was (lovingly) forked from soundcloud/chunk-manifest-webpack-plugin.

Usage

Install via npm:

npm install --save-dev webpack-chunk-manifest-plugin

Install via yarn:

yarn add --dev webpack-chunk-manifest-plugin

And then require and provide to webpack:

// in webpack.config.js or similar
const ChunkManifestPlugin = require('webpack-chunk-manifest-plugin');

module.exports = {
  // your config values here
  plugins: [
    new ChunkManifestPlugin({
      filename: 'manifest.json',
      manifestVariable: 'webpackManifest',
      inlineManifest: false
    })
  ]
};

Options

filename

Where the manifest will be exported to on bundle compilation. This will be relative to the main webpack output directory. Default = "manifest.json"

manifestVariable

What JS variable on the client webpack should refer to when requiring chunks. Default = "webpackManifest"

inlineManifest

Whether or not to write the manifest output into the html-webpack-plugin. Default = false

// index.ejs
<body>
    <!-- app -->
    <%= htmlWebpackPlugin.files.webpackManifest %>
</body>