cs42 / cachebust-brunch

Fingerprints assets for cache busting

cachebust-brunch

The best of fingerprinter-brunch, hashfingerprint-brunch, and timestamp-brunch.

A Brunch plugin that will rename assets with an unique SHA hash. This will allow better caching of assets. It will automatically rewrite the urls, and also write to a manifest file.

Usage

npm install --save cachebust-brunch

Note: make sure cachebust-brunch is listed before gzip-brunch in the dependency list of your package.json

Note: make sure cachebust-brunch is listed after uglify-brunch in the dependency list of your package.json

Options

Default configuration:

module.exports = config:
  plugins:
    cachebust:
      manifest: 'public/manifest.json'
      environments: ['production']
      reference: ['index.html']
      extensions: [
        /\.js$/
        /\.css$/
      ]
      precision: 8

manifest

Output location of the manifest file.

reference

The file where the urls should be rewritten.

extensions

Array of extensions to match. Regex must be acceptable by str.match. The array will be matched against the list of generated files.

precision

The number of characters of the SHA1 hash to use in the hashed filename. Default should be fine.

Brunch build

brunch build

Script tags will compile as

<script src="js/vendor.js"></script>
<script src="js/app.js"></script>

brunch build --production

Script tags will compile as

<script src="js/vendor-24179978.js"></script>
<script src="js/app-24179978.js"></script>

License

MIT