Require Node.js 8 and Gulp 4

Author: sindresorhus

.travis.yml

@@ -1,5 +1,5 @@
 language: node_js
 node_js:
+  - '12'
   - '10'
   - '8'
-  - '6'

index.js

@@ -9,7 +9,7 @@ const modifyFilename = require('modify-filename');
 const Vinyl = require('vinyl');
 const PluginError = require('plugin-error');
 
-function relPath(base, filePath) {
+function relativePath(base, filePath) {
 	filePath = filePath.replace(/\\/g, '/');
 	base = base.replace(/\\/g, '/');
 
@@ -43,43 +43,47 @@ function transformFilename(file) {
 	});
 }
 
-const getManifestFile = opts => vinylFile.read(opts.path, opts).catch(error => {
-	if (error.code === 'ENOENT') {
-		return new Vinyl(opts);
-	}
+const getManifestFile = async options => {
+	try {
+		return await vinylFile.read(options.path, options);
+	} catch (error) {
+		if (error.code === 'ENOENT') {
+			return new Vinyl(options);
+		}
 
-	throw error;
-});
+		throw error;
+	}
+};
 
 const plugin = () => {
 	const sourcemaps = [];
 	const pathMap = {};
 
-	return through.obj((file, enc, cb) => {
+	return through.obj((file, encoding, callback) => {
 		if (file.isNull()) {
-			cb(null, file);
+			callback(null, file);
 			return;
 		}
 
 		if (file.isStream()) {
-			cb(new PluginError('gulp-rev', 'Streaming not supported'));
+			callback(new PluginError('gulp-rev', 'Streaming not supported'));
 			return;
 		}
 
 		// This is a sourcemap, hold until the end
 		if (path.extname(file.path) === '.map') {
 			sourcemaps.push(file);
-			cb();
+			callback();
 			return;
 		}
 
 		const oldPath = file.path;
 		transformFilename(file);
 		pathMap[oldPath] = file.revHash;
 
-		cb(null, file);
-	}, function (cb) {
-		sourcemaps.forEach(file => {
+		callback(null, file);
+	}, function (callback) {
+		for (const file of sourcemaps) {
 			let reverseFilename;
 
 			// Attempt to parse the sourcemap's JSON to get the reverse filename
@@ -103,60 +107,68 @@ const plugin = () => {
 			}
 
 			this.push(file);
-		});
+		}
 
-		cb();
+		callback();
 	});
 };
 
-plugin.manifest = (pth, opts) => {
-	if (typeof pth === 'string') {
-		pth = {path: pth};
+plugin.manifest = (path_, options) => {
+	if (typeof path_ === 'string') {
+		path_ = {path: path_};
 	}
 
-	opts = Object.assign({
+	options = {
 		path: 'rev-manifest.json',
 		merge: false,
-		transformer: JSON
-	}, opts, pth);
+		transformer: JSON,
+		...options,
+		...path_
+	};
 
 	let manifest = {};
 
-	return through.obj((file, enc, cb) => {
+	return through.obj((file, encoding, callback) => {
 		// Ignore all non-rev'd files
 		if (!file.path || !file.revOrigPath) {
-			cb();
+			callback();
 			return;
 		}
 
-		const revisionedFile = relPath(path.resolve(file.cwd, file.base), path.resolve(file.cwd, file.path));
+		const revisionedFile = relativePath(path.resolve(file.cwd, file.base), path.resolve(file.cwd, file.path));
 		const originalFile = path.join(path.dirname(revisionedFile), path.basename(file.revOrigPath)).replace(/\\/g, '/');
 
 		manifest[originalFile] = revisionedFile;
 
-		cb();
-	}, function (cb) {
+		callback();
+	}, function (callback) {
 		// No need to write a manifest file if there's nothing to manifest
 		if (Object.keys(manifest).length === 0) {
-			cb();
+			callback();
 			return;
 		}
 
-		getManifestFile(opts).then(manifestFile => {
-			if (opts.merge && !manifestFile.isNull()) {
-				let oldManifest = {};
+		(async () => {
+			try {
+				const manifestFile = await getManifestFile(options);
 
-				try {
-					oldManifest = opts.transformer.parse(manifestFile.contents.toString());
-				} catch (_) {}
+				if (options.merge && !manifestFile.isNull()) {
+					let oldManifest = {};
 
-				manifest = Object.assign(oldManifest, manifest);
-			}
+					try {
+						oldManifest = options.transformer.parse(manifestFile.contents.toString());
+					} catch (_) {}
 
-			manifestFile.contents = Buffer.from(opts.transformer.stringify(sortKeys(manifest), null, '  '));
-			this.push(manifestFile);
-			cb();
-		}).catch(cb);
+					manifest = Object.assign(oldManifest, manifest);
+				}
+
+				manifestFile.contents = Buffer.from(options.transformer.stringify(sortKeys(manifest), undefined, '  '));
+				this.push(manifestFile);
+				callback();
+			} catch (error) {
+				callback(error);
+			}
+		})();
 	});
 };
 

integration.md

@@ -10,14 +10,14 @@ For our examples, we'll assume the following `rev-manifest.json`:
 	"js/lib.js": "js/lib-6d94673e3d.js",
 	"css/app.css": "css/app-a4ae3dfa4d.css"
 }
-````
+```
 
 
 ## Approach #1 - Generate index.html during build
 
 One approach to working with `rev-manifest.json` is to use a templating language, such as [handlebars](http://handlebarsjs.com), to generate an `index.html` file which contained your fingerprinted files embedded into the page.
 
-The idea is to read in your app's `rev-manifest.json`, and use the non-fingerprinted path to read in the fingerprinted path and inject it into the page. Note, this approach requires the `'compile index.html'` task to be run as part of your build process.
+The idea is to read in your app's `rev-manifest.json`, and use the non-fingerprinted path to read in the fingerprinted path and inject it into the page. Note, this approach requires the `'compile-index-html'` task to be run as part of your build process.
 
 #### `index.hbs`
 
@@ -38,32 +38,30 @@ The idea is to read in your app's `rev-manifest.json`, and use the non-fingerpri
 #### `gulpfile.js`
 
 ```js
-var fs = require('fs');
-var gulp = require('gulp');
-var handlebars = require('gulp-compile-handlebars');
-var rename = require('gulp-rename');
+const fs = require('fs');
+const gulp = require('gulp');
+const handlebars = require('gulp-compile-handlebars');
+const rename = require('gulp-rename');
 
-// create a handlebars helper to look up
+// Create a handlebars helper to look up
 // fingerprinted asset by non-fingerprinted name
-var handlebarOpts = {
+const handlebarOpts = {
 	helpers: {
-		assetPath: function (path, context) {
-			return ['/assets', context.data.root[path]].join('/');
-		}
+		assetPath: (path, context) => ['/assets', context.data.root[path]].join('/')
 	}
 };
 
-gulp.task('compile index.html', function () {
-	// read in our manifest file
-	var manifest = JSON.parse(fs.readFileSync('path/to/rev-manifest', 'utf8'));
+exports['compile-index-html'] = () => {
+	// Read in our manifest file
+	const manifest = JSON.parse(fs.readFileSync('path/to/rev-manifest', 'utf8'));
 
-	// read in our handlebars template, compile it using
+	// Read in our handlebars template, compile it using
 	// our manifest, and output it to index.html
 	return gulp.src('index.hbs')
 		.pipe(handlebars(manifest, handlebarOpts))
 		.pipe(rename('index.html'))
 		.pipe(gulp.dest('public'));
-});
+};
 ```
 
 
@@ -74,20 +72,20 @@ Another approach would be to make a AJAX request to get the manifest JSON blob,
 For example, if you wanted to include your JavaScript files into the page:
 
 ```js
-$.getJSON('/path/to/rev-manifest.json', function (manifest) {
-	var s = document.getElementsByTagName('script')[0];
+$.getJSON('/path/to/rev-manifest.json', manifest => {
+	const s = document.getElementsByTagName('script')[0];
 
-	var assetPath = function (src) {
-		src = 'js/' + src + '.js'
+	const assetPath = src => {
+		src = `js/${src}.js`;
 		return ['/assets', manifest[src]].join('/');
 	};
 
-	['lib', 'app'].forEach(function (src) {
-		var el = document.createElement('script');
-		el.async = true;
-		el.src = assetPath(src);
-		s.parentNode.insertBefore(el, s);
-	});
+	for (const src of ['lib', 'app']) {
+		const element = document.createElement('script');
+		element.async = true;
+		element.src = assetPath(src);
+		s.parentNode.insertBefore(element, s);
+	}
 })
 ```
 
@@ -102,7 +100,7 @@ If the file is not present in the manifest it will return the original filename.
 
 ```php
 /**
- * @param  string  $filename
+ * @param string $filename
  * @return string
  */
 function asset_path($filename) {

package.json

@@ -10,7 +10,7 @@
 		"url": "sindresorhus.com"
 	},
 	"engines": {
-		"node": ">=6"
+		"node": ">=8"
 	},
 	"scripts": {
 		"test": "xo && ava"
@@ -36,16 +36,19 @@
 	"dependencies": {
 		"modify-filename": "^1.1.0",
 		"plugin-error": "^1.0.1",
-		"rev-hash": "^2.0.0",
+		"rev-hash": "^3.0.0",
 		"rev-path": "^2.0.0",
-		"sort-keys": "^2.0.0",
-		"through2": "^2.0.0",
+		"sort-keys": "^4.0.0",
+		"through2": "^3.0.1",
 		"vinyl": "^2.1.0",
 		"vinyl-file": "^3.0.0"
 	},
 	"devDependencies": {
-		"ava": "^0.25.0",
-		"p-event": "^2.1.0",
-		"xo": "^0.23.0"
+		"ava": "^2.3.0",
+		"p-event": "^4.1.0",
+		"xo": "^0.24.0"
+	},
+	"peerDependencies": {
+		"gulp": ">=4"
 	}
 }