gulp-rev-hash2

appends a file's hash to a file URL in html file

Note

This Gulp plugin is fork from gulp-rev-mtime https://github.com/thomastuts/gulp-rev-mtime, I just modify fs.statSync().mtime to md5-file

Install

npm install --save-dev gulp-rev-hash2

Examples

Default

This example will take the example.html file and add rev tags to all files that are found in this file, with default options.

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

gulp.task('rev', function () {
	gulp.src('template.html')
		.pipe(rev())
		.pipe(gulp.dest('.'));
});

Input:

<link rel="stylesheet" href="main.min.css"/>

<script src="abc.js"></script>
<script src="def.js"></script>

Output:

<link rel="stylesheet" href="main.min.css?v=9d58b7441d92130f545778e418d1317d">

<script src="abc.js?v=0401f2bda539bac50b0378d799c2b64e"></script>
<script src="def.js?v=e478ca95198c5a901c52f7a0f91a5d00"></script>

Custom options

This example will take the example.html file and add rev tags to all files that are found in this file with the custom options provided.

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

gulp.task('rev', function () {
	gulp.src('template.html')
		.pipe(rev({
		  'cwd': 'public/assets',
		  'suffix': 'rev',
		  'fileTypes': ['css']
		}))
		.pipe(gulp.dest('.'));
});

Input:

<link rel="stylesheet" href="main.min.css"/>

<script src="abc.js"></script>
<script src="def.js"></script>

Output:

<link rel="stylesheet" href="main.min.css?rev=9d58b7441d92130f545778e418d1317d">

<script src="abc.js"></script>
<script src="def.js"></script>

---

API

rev(options)

options.cwd

Type: String
Default: ''

Acts as a working directory for your assets, if your assets are not located in the root folder of the opened file.

options.suffix

Type: String
Default: 'v'

The name of the query parameter for versioning. Example: <script src="def.js?v=9d58b7441d92130f545778e418d1317d"></script>

options.fileTypes

Type: Array
Default: ['js', 'css']

You can choose which files to add version tags to. Use this option if you only want to add version tags to specific file types.