Unsupported
I am no longer maintaining digest-brunch. I switched to Webpack for my front end applications. Contact me (@mutewinter) if you'd like to take over support for digest-brunch.
digest-brunch
A Brunch plugin that appends a unique SHA digest to asset filenames. Allows for far-future caching of assets.
Note: digest-brunch is not compatible with gzip-brunch.
Usage
npm install --save digest-brunch
Identify assets that you want to be digested with DIGEST(filename.ext)
, or a custom pattern of your choosing.
Run brunch build --production
and you'll see something like the following:
Note: digest-brunch can not be run in watch
mode. It's only intended for
production builds, run once.
The asset files are also renamed, inside the public folder, to match the names above.
Options
Optional You can override digest-brunch's default options by updating your
config.coffee
with overrides.
These are the default settings:
exports.config = # ... plugins: digest: # A RegExp where the first subgroup matches the filename to be replaced pattern: /DIGEST\(\/?\)/g # After replacing the filename, should we discard the non-filename parts of the pattern? discardNonFilenamePatternParts: yes # RegExp that matches files that contain DIGEST references. referenceFiles: /\.html$/ # How many digits of the SHA1 to append to digested files. precision: 8 # Force digest-brunch to run in all environments when true. alwaysRun: false # Specify an array of environments to run in. environments: 'production' # Prepend an asset host URL to the file paths in the reference files. Use an object e.g. {production: 'http://production-asset-host.co'} prependHost: null # Output filename for a JSON manifest of reference file paths and their digest. manifest: '' # An array of infixes for alternate versions of files. This is useful when e.g. using retina.js (http://imulus.github.io/retinajs/) (@2x) for high density images. infixes:
Contributing
- Add some code
- Add some tests
- Run
npm test
- Send a pull request
License
MIT