Skip to content
Rewrite references to assets revisioned by `gulp-rev`
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib fix: allow replacing in query parameters Jan 15, 2019
test
.gitignore
.travis.yml ci: remove node 6 and add node 12 to travis Jul 2, 2019
LICENSE build: change package name and ownership May 5, 2018
README.md docs: rewrite usage examples Jul 2, 2019
index.js chore(package): update xo to version 0.25.0 (#22) Sep 26, 2019
package.json chore(package): update xo to version 0.25.0 (#22) Sep 26, 2019

README.md

gulp-rev-rewrite Build Status npm semantic-release Greenkeeper badge

Rewrite references to assets revisioned by gulp-rev

This plugin is an improved and maintained fork of gulp-rev-replace.

Install

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

Only LTS and current releases of Node are supported.

Usage

The most common use pattern consists of two steps:

  1. Revision your assets and create an asset manifest.
  2. Collect the revisioned paths from the manifest and rewrite references to them
const { src, dest, series } = require('gulp');
const rev = require('gulp-rev');
const revRewrite = require('gulp-rev-rewrite');

// Step 1
function revision() {
  return src('dist/assets/**/*.{css,js}')
    .pipe(rev())
    .pipe(dest('dist/assets'))
    .pipe(rev.manifest())
    .pipe(dest('dist/assets'));
}

// Step 2
function rewrite() {
  const manifest = src('dist/assets/rev-manifest.json');

  return src('dist/**/*.html')
    .pipe(revRewrite({ manifest }))
    .pipe(dest('dist'));
}

exports.default = series(revision, rewrite);

Alternatively, you can combine both steps with the use of gulp-filter.

const { src, dest } = require('gulp');
const filter = require('gulp-filter');
const rev = require('gulp-rev');
const revRewrite = require('gulp-rev-rewrite');

function revision() {
  const assetFilter = filter(['**', '!**/*.html'], { restore: true });

  return src('dist/**')
    .pipe(assetFilter)
    .pipe(rev()) // Rename all files except html files
    .pipe(assetFilter.restore)
    .pipe(revRewrite())
    .pipe(dest('dist'));
}

exports.default = revision;

API

revRewrite([options])

options

Type: Object

manifest

Type: Stream (e.g., gulp.src())

Read JSON manifests written out by rev. Allows replacing filenames that were revisioned prior to the current task.

prefix

Type: String

Add a prefix to each replacement.

modifyUnreved, modifyReved

Type: Function

Modify the name of the unreved/reved files before using them. The function receives the unreved/reved filename as the first argument, and the Vinyl object of the current file as the optional second argument.

For example, if in your manifest you have:

{"js/app.js.map": "js/app-98adc164.js.map"}

If you wanted to get rid of the js/ path just for .map files (because they are sourcemaps and the references to them are relative, not absolute) you could do the following:

const { src, dest } = require('gulp');

function replaceJsIfMap(filename) {
  if (filename.includes('.map')) {
    return filename.replace('js/', '');
  }
  return filename;
}

function rewrite() {
  return src('dist/**/*.js')
    .pipe(revRewrite({
        manifest: src('rev-manifest.json'),
        modifyUnreved: replaceJsIfMap,
        modifyReved: replaceJsIfMap
      }))
    .pipe(dest('dist'));
}

exports.default = rewrite;    

License

MIT © James K Nelson, Thomas Vantuycom

You can’t perform that action at this time.