gulp-rev-rewrite

Effortlessly rewrite references to revisioned assets by incorporating gulp-rev-rewrite into your revisioning workflow powered by gulp-rev.

Install

npm install gulp-rev-rewrite --save-dev

Usage

Option 1: Inline revisioning

In this approach, revisioning and rewriting are done in a single gulp task.

1import gulp from 'gulp';
2import rev from 'gulp-rev';
3import revRewrite from 'gulp-rev-rewrite';
4
5function revision() {
6  return gulp.src('dist/**/*.{css,js}')
7    .pipe(rev())
8    .pipe(gulp.src('dist/**/*.html'))
9    .pipe(revRewrite())
10    .pipe(gulp.dest('dist'));
11}
12
13export default revision;

Option 2: Separate revisioning and rewriting

This approach separates asset revisioning from rewriting references to the revisioned assets.

1import { readFileSync } from 'node:fs';
2import gulp from 'gulp';
3import rev from 'rev';
4import revRewrite from 'gulp-rev-rewrite';
5
6// Step 1: Asset revisioning
7function revision() {
8  return gulp.src('dist/assets/**/*.{css,js}')
9    .pipe(rev())
10    .pipe(gulp.dest('dist/assets'))
11    .pipe(rev.manifest())
12    .pipe(gulp.dest('dist/assets'));
13}
14
15// Step 2: Rewriting references
16function rewrite() {
17  const manifest = readFileSync('dist/assets/rev-manifest.json');
18
19  return gulp.src('dist/**/*.html')
20    .pipe(revRewrite({ manifest }))
21    .pipe(gulp.dest('dist'));
22}
23
24export default gulp.series(revision, rewrite);

API

revRewrite([options])

options

Type: Object

manifest

Type: Buffer (e.g., fs.readFileSync())

Read JSON manifests generated by gulp-rev. This allows replacing filenames that were revisioned in a previous task.

License

MIT © Thomas Vantuycom