/gulp-rev

Static asset revisioning by appending content hash to filenames: unicorn.css => unicorn-098f6bcd.css

Primary LanguageJavaScript

gulp-rev Build Status

Static asset revisioning by appending content hash to filenames
unicorn.css => unicorn-098f6bcd.css

Make sure to set the files to never expire for this to have an effect.

Install

$ npm install --save-dev gulp-rev

Usage

var gulp = require('gulp');
var rev = require('gulp-rev');

gulp.task('default', function () {
	gulp.src('src/*.css')
		.pipe(rev())
		.pipe(gulp.dest('dist'));
});

Options are intentionally missing as the default should work in most cases.

Original path

Original file paths are stored at file.revOrigPath. This could come in handy for things like rewriting references to the assets.

Asset manifest

var gulp = require('gulp');
var rev = require('gulp-rev');

gulp.task('default', function () {
	// 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(rev())
		.pipe(gulp.dest('build/assets'))  // write rev'd assets to build dir
		.pipe(rev.manifest())
		.pipe(gulp.dest('build/assets')); // write manifest to build dir
});

An asset manifest, mapping the original paths to the revisioned paths, will be written to dist/rev-manifest.json:

{
	"css/unicorn.css": "css/unicorn-098f6bcd.css"
}

License

MIT © Sindre Sorhus