gulp-rev-all
Advanced tools
Static asset revisioning by appending content hash to filenames: unicorn.css => unicorn.098f6bcd.css, also re-writes references in each file to new reved name.
Static asset revisioning with dependency considerations, appends content hash to each filename (eg. unicorn.css => unicorn.098f6bcd.css), re-writes references.
By using the Expires header you can make static assets cacheable for extended periods of time so that visitors to your website do not need to make unnecessary HTTP requests for subsequent page views. Also content distribution networks like CloudFront let you cache static assets in Edge Locations for extended periods of time. A problem occurs however when you go to release a new version of your website, previous visitors of your website will hit their cache instead. In the case of CloudFront, you will need to invalidate items or wait for the cache TTL to expire before vistors of your website will see the vew version.
A solution to this problem is adding a revisioned number to the name your static assets. In the case of this gulp plugin, the revision number is md5( md5(file) + md5(reference1) + md5(reference2) + md5(reference..) ).substr(0, 8). eg. unicorn.css => unicorn.098f6bcd.css
This project was forked from gulp-rev to add reference processing and rewriting functionality.
It is the philosophy of gulp-rev that concerns should be seperated between revisioning the files and re-writing references to those files. gulp-rev-all does not agree with this, we believe you need analyze each revisioned files' references, to calculate a final hash for caching purposes.
A css file makes reference to an image. If the image changes, the hash of the css file remains the same since its contents have not changed. Web clients that have previously cached this css file will not correctly resolve the new image. If we take in to consideration the dependency graph while calculating the css file hash, we can have it change if any of its child references have changed.
So to recap, gulp-rev-all not only handles reference re-writing but it also takes child references into consideration when calculating a hashes.
NOTICE: Major breaking changes occured between the last release v0.7.6 and v0.8.0 that you should be aware of.
var revAll = new RevAll() instance before piping through revAll.revision()ignore option has been removed and has been replaced with dontGlobal, dontRenameFile, dontUpdateReference which allows for more control and less ambiguity on what is being ignored.silent & quiet options, renamed to debug to control logging outputInstall with npm
npm install --save-dev gulp-rev-all
var gulp = require('gulp');
var RevAll = require('gulp-rev-all');
gulp.task('default', function () {
var revAll = new RevAll();
gulp.src('dist/**')
.pipe(revAll.revision())
.pipe(gulp.dest('cdn'));
});
var gulp = require('gulp');
var RevAll = require('gulp-rev-all');
var awspublish = require('gulp-awspublish');
var cloudfront = require("gulp-cloudfront");
var aws = {
"key": "AKIAI3Z7CUAFHG53DMJA",
"secret": "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",
"bucket": "bucket-name",
"region": "us-standard",
"distributionId": "E1SYAKGEMSK3OD"
};
var publisher = awspublish.create(aws);
var headers = {'Cache-Control': 'max-age=315360000, no-transform, public'};
gulp.task('default', function () {
var revAll = new RevAll();
gulp.src('dist/**')
.pipe(revAll.revision())
.pipe(awspublish.gzip())
.pipe(publisher.publish(headers))
.pipe(publisher.cache())
.pipe(awspublish.reporter())
.pipe(cloudfront(aws));
});
Original file paths are stored at file.revPathOriginal.
The hash of each rev'd file is stored at file.revHash. You can use this for customizing the file renaming, or for building different manifest formats.
var gulp = require('gulp');
var RevAll = require('gulp-rev-all');
gulp.task('default', function () {
var revAll = new RevAll();
// by default, gulp would pick `assets/css` as the base,
// so we need to set it explicitly:
return gulp.src(['assets/css/*.css', 'assets/js/*.js'], { base: 'assets' })
.pipe(gulp.dest('build/assets')) // Copy original assets to build dir
.pipe(revAll.revision())
.pipe(gulp.dest('build/assets')) // Write rev'd assets to build dir
.pipe(revAll.manifestFile())
.pipe(gulp.dest('build/assets')); // Write manifest file to build dir
.pipe(revAll.versionFile())
.pipe(gulp.dest('build/assets')); // Write version file to build dir
});
An asset manifest, mapping the original paths to the revisioned paths, will be written to build/assets/rev-manifest.json:
{
"css/unicorn.css": "css/unicorn.098f6bcd.css",
"js/unicorn.js": "js/unicorn.273c2cin.js"
}
The version file will contain the build date and a combined hash of all the revisioned files, will be written to build/assets/rev-version.json.
{
"hash": "c969a1154f2a5c0689d8ec4b0eafd584",
"timestamp": "2014-10-11T12:13:48.466Z"
}
Set the filename of the file created by revAll.versionFile()
Type: String
Default: rev-version.json
Set the filename of the file created by revAll.manifsetFile()
Type: String
Default: rev-manifset.json
Don't rename, search or update refrences in files matching these rules
Type: Array of (Regex and/or String)
Default: [ /^\/favicon.ico$/ ]
Don't rename files matching these rules
Type: Array of (Regex and/or String)
Default: []
Don't update references matching these rules
Type: Array of (Regex and/or String)
Default: []
Don't search for references in files matching these rules
Type: Array of (Regex and/or String)
Default: []
In some cases, you may not want to rev your *.html files:
gulp.task('default', function () {
var revAll = new RevAll({ dontRenameFile: [/^\/favicon.ico$/g, '.html'] });
gulp.src('dist/**')
.pipe(revAll.revision())
.pipe(gulp.dest('cdn'))
});
Every html file except the root /index.html file:
gulp.task('default', function () {
var revAll = new RevAll({ dontRenameFile: [/^\/favicon.ico$/g, /^\/index.html/g] });
gulp.src('dist/**')
.pipe(revAll.revision()))
.pipe(gulp.dest('cdn'))
});
Type: hashLength
Default: 8
Change the length of the hash appended to the end of each revisioned file (use options.transformFilename for more complicated scenarios).
gulp.task('default', function () {
var revAll = new RevAll({ hashLength: 4 });
gulp.src('dist/**')
.pipe(revAll.revision())
.pipe(gulp.dest('cdn'))
});
Type: prefix
Default: none
Prefixes matched files with a string (use options.transformPath for more complicated scenarios). Useful for adding a full url path to files.
gulp.task('default', function () {
var revAll = new RevAll({ prefix: 'http://1234.cloudfront.net/' });
gulp.src('dist/**')
.pipe(revAll.revision())
.pipe(gulp.dest('cdn'))
});
Type: function (rev, source, path)
Default: none
Specify a function to transform the reference path. Useful in instances where the local file structure does not reflect what the remote file structure will be.
The function takes three arguments:
rev - revisioned reference pathsource - original reference pathpath - path to the filegulp.task('default', function () {
var revAll = new RevAll({
transformPath: function (rev, source, path) {
// on the remote server, image files are served from `/images`
return rev.replace('/img', '/images');
}
});
gulp.src('dist/**')
.pipe(revAll.revision())
.pipe(gulp.dest('cdn'))
});
Type: function (file, hash)
Default: none
If the default naming convention does not suite your needs, you can specify a custom filename transform.
The function takes one argument:
file - file to be revisionedhash - calculated hash of the filegulp.task('default', function () {
var revAll = new RevAll({
transformFilename: function (file, hash) {
var ext = path.extname(file.path);
return hash.substr(0, 5) + '.' + path.basename(file.path, ext) + ext; // 3410c.filename.ext
}
});
gulp.src('dist/**')
.pipe(revAll.revision())
.pipe(gulp.dest('cdn'))
});
Type: String or []
Default: none
This option allows you to set addition search paths gulp-rev-all will use to resolve file references.
Type: Boolean
Default: false
If you set this options to true, verbose logging will be emitted to console.
Make sure to set the files to never expire for this to have an effect.
FAQs
Static asset revisioning by appending content hash to filenames: unicorn.css => unicorn.098f6bcd.css, also re-writes references in each file to new reved name.
The npm package gulp-rev-all receives a total of 7,752 weekly downloads. As such, gulp-rev-all popularity was classified as popular.
We found that gulp-rev-all demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.