fly-rev
Prepare front-end assets for cache-busting / versioning / hashing.
This plugin includes three functions:
rev()
: Rename files by appending a unique hash, based on contents.revManifest()
: Create a manifest that maps old filenames to newly versioned filenames. (optional)revReplace()
: Update all references to versioned files. (optional)
Make sure to set the files to never expire for this to have an effect.
Install
npm install --save-dev fly-rev
Usage
The rev()
task is the core method; thus is required for anything to occur.
Both revManifest()
and revReplace()
are optional plugins.
exports { flysource'app/**/*' rev ignores: '.html' '.jpg' '.png' target'dist';}
API
.rev(options)
Generate a unique hash (based on a file's contents) and append it to the filename.
bundlejs//=> bundle-{hash}.jsbundleminjs//=> bundle-{hash}.min.js
Any files that are processed will receive two new keys: orig
and hash
. In addition, the base
key will be updated with the new, versioned filename.
options.ignores
Type: array
Default: ['.png', 'jpg', '.jpeg', '.svg', '.gif', '.woff', '.ttf', '.eot']
A list of file extensions that should NOT be renamed/processed.
revManifest(options)
Create a manifest file that relates old filenames to versioned counterparts.
options.file
Type: string
Default: 'rev-manifest.json'
The name of the manifest file to be created.
options.dest
Type: string
Default: fly.root
The directory where your manifest file should be created. Defaults to Fly's root directory (where flyfile.js
is found).
options.sort
Type: boolean
Default: true
Whether or not the manifest's contents should be sorted alphabetically. (Does not add any performance / usage benefits.)
options.trim
Type: string
or function
Default: .
Edit the final keys & values within the manifest. If string
, the value will be resolved relative to Fly's root directory. Using a function
provides more fine-tuned control.
flysource'app/client/*.js'rev target'dist'; //=> "client/demo.js": "client/demo-1abd624s.js" flysource'app/client/*.js'rev target'dist'; //=> "assets/demo.js": "assets/demo-1abd624s.js"
revReplace(options)
Update references to all versioned files within a given source.
Matching files from within fly.source()
are available for inspection & modifications. Because of this, it is recommended that all your rev-*
usage is extracted to a separate, production-only task whose source
includes all development files.
options.ignores
Type: array
Default: ['.png', 'jpg', '.jpeg', '.svg', '.gif', '.woff', '.ttf', '.eot']
A list of file extensions whose content should not be updated.
License
MIT © Luke Edwards