cache-bust-plugin
TypeScript icon, indicating that this package has built-in type declarations

1.0.1 • Public • Published

GitHub npm bundle size npm

What is cache-bust-plugin?

cache-bust-plugin is a tiny Webpack plugin for generating bundle hashes. It's a useful alternative to html-webpack-plugin for when you only require cache-busting.

Installation

Install the cache-bust-plugin package from npm.
npm install cache-bust-plugin

Usage

import {CacheBustPlugin} from "cache-bust-plugin";

export const webpackConfig = {
    // ... Webpack config
    plugins: [
        new CacheBustPlugin({
            // ... cache-bust-plugin options
        })
    ]
}

If the writeToIndexHtml option is used then cache-bust-plugin searches for bundle file names in index.html (located in the root directory of your project) and appends bundle hashes using a query string.

index.html (before cache-bust-plugin) =>
<script type="text/javascript" src="/app.js"></script>
index.html (after cache-bust-plugin) =>
<script type="text/javascript" src="/app.js?hash=68b1a4d74cf4ef2b516f492bef010d8e"></script>

If the writeToJson option is used then cache-bust-plugin will write the bundle hashes to a JSON formatted text file.

{
  "app.css": "faa879842aef4070b5563ccdc0016cf8",
  "app.js": "faa879842aef4070b5563ccdc0016cf8",
  "vendor.js": "e5487614083955d6896b53ac06edaffb"
}

Options

The following options are available:

Option Description
writeToIndexHtml Add bundle hashes to index.html as a query string using text replacement
writeToJson Write bundle hashes to JSON formatted text file
jsonFileName Used with writeToJson option (defaults to version.json)

Dependencies (0)

    Dev Dependencies (8)

    Package Sidebar

    Install

    npm i cache-bust-plugin

    Weekly Downloads

    3

    Version

    1.0.1

    License

    MIT

    Unpacked Size

    20 kB

    Total Files

    24

    Last publish

    Collaborators

    • rmuchall