Namespace, Primitive, Method
    Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    gulp-hashpublic

    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)

    Option Default Description
    algorithm 'sha1' A hashing algorithm for crypto.createHash
    hashLength 8 The 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)

    Parameter Default Description
    manifestPath (none) The desired path to the manifest file
    options.append true Whether to merge the new manifest with an existing one's contents (same filename, doesn't have to exist before first run)
    options.space null The space parameter for JSON.stringify()
    options.deleteOld false If set to true, deletes old versions of hashed files
    options.sourceDir __dirname Used with deleteOld. Specifies where to search for old files to delete.

    hash.manifest(manifestPath, append, space)

    Parameter Default Description
    manifestPath (none) The desired path to the manifest file
    append true (optional) Whether to merge the new manifest with an existing one's contents (same filename, doesn't have to exist before first run)
    space undefined (optional) The space parameter for JSON.stringify()

    install

    npm i gulp-hash

    Downloadsweekly downloads

    3,688

    version

    4.2.2

    license

    MIT

    repository

    github.com

    last publish

    collaborators

    • avatar