Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including gulp-hash with all npm packages installed. Try it out:

var gulpHash = require("gulp-hash")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

gulp-hash v4.2.2

Cachebust your assets by adding a hash to the filename

gulp-hash NPM version Build Status

Cachebust your assets by adding a hash to the filename

npm install --save-dev gulp-hash

Basic usage

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

gulp.src('./js/**/*.js')
    .pipe(hash()) // Add hashes to the files' names
    .pipe(gulp.dest('public/js')) // Write the renamed files
    .pipe(hash.manifest('public/assets.json', { // Generate the manifest file
      deleteOld: true,
      sourceDir: __dirname + '/public/js'
    }))
    .pipe(gulp.dest('.')); // Write the manifest file (see note below)

The "manifest" is a JSON file that maps the original filenames to the renamed ones.

Note: It is recommended to use the full relative path to the manifest file in hash.manifest() as opposed to setting it in gulp.dest(). This is so the append option is able find the original manifest file. The example above demonstrates this.

Streaming

The plugin fully supports both buffers and streams. If you encounter any problems, please open an issue on GitHub and I'll look into it!

API

hash(options)

OptionDefaultDescription
algorithm'sha1'A hashing algorithm for crypto.createHash
hashLength8The length of the hash to add to the file's name (slice from the start of the full hash)
template'<%= name %>-<%= hash %><%= ext %>'The template used when adding the hash
version''A key to change the files' hashes without actually changing their content; appended to the contents when hashing

hash.manifest(manifestPath, options)

ParameterDefaultDescription
manifestPath(none)The desired path to the manifest file
options.appendtrueWhether to merge the new manifest with an existing one's contents (same filename, doesn't have to exist before first run)
options.spacenullThe space parameter for JSON.stringify()
options.deleteOldfalseIf set to true, deletes old versions of hashed files
options.sourceDir__dirnameUsed with deleteOld. Specifies where to search for old files to delete.

hash.manifest(manifestPath, append, space)

ParameterDefaultDescription
manifestPath(none)The desired path to the manifest file
appendtrue(optional) Whether to merge the new manifest with an existing one's contents (same filename, doesn't have to exist before first run)
spaceundefined(optional) The space parameter for JSON.stringify()
RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free