grunt-userev

Update references to assets versioned with grunt-filerev. Leaner and faster than grunt-usemin, and able to update already versioned references.

Getting Started

This plugin requires Grunt.

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-userev --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-userev');

The "userev" task

Overview

In your project's Gruntfile, configure userev to update references to assets versioned by grunt-filerev. It will automatically use grunt.filerev.summary.

grunt.initConfig({
  filerev: {
    options: {
      encoding: 'utf8',
      algorithm: 'md5',
      length: 8
    },
    sourcemaps: {        // Rename sourcemaps.
      src: ['build/css/*.map.css', 'build/js/*.map.js'],
    },
    assets: {            // Rename minified js/css.
      src: ['build/css/*.css', 'build/js/*.js', '!build/css/*.map.css', '!build/js/*.map.js'],
    },
  },

  userev: {
    options: {
      hash: /(\.[a-f0-9]{8})\.[a-z]+$/,
    },
    assets: {            // Link to sourcemaps in minified js/css.
      src: ['build/css/*.css', 'build/js/*.js', '!build/css/*.map.css', '!build/js/*.map.js'],
      options: {
        patterns: {
          'Linking versioned source maps': /sourceMappingURL=([a-z0-9.]*\.map)/,
        },
      },
    },
    index: {             // Link to minified js/css in index html.
      src: 'build/index.html',
      options: {
        patterns: {
          'Linking versioned assets': /(css\/[a-z0-9.]*\.css)/,
        },
      },
    },
  },
});

grunt.registerTask( 'rev', [
  'filerev:sourcemaps',  // Rename sourcemaps.
  'userev:assets',       // Link to sourcemaps in minified js/css.
  'filerev:assets',      // Rename minified js/css.
  'userev:index',        // Link to minified js/css in index html.
]);

Options

patterns

Type: Object {Key: RegExp} Default: none

Reference RegExp patterns are matched in source files. The first matched group is checked if it matches ending of any key in grunt.filerev.summary. The key names are used to log processing of matched patterns.

hash

Type: RegExp Default: none

If specified, the RegExp pattern is matched against matched references and the first matched group (the hash in filename) is removed. This allows to update the references in source files multiple times without need to regenerate them.

Roadmap

• Add changelog
• Extend tests

Contributing

Welcome to the project. Choose a way that suits you. You'll need a GitHub account.

Submit a bug, or feature request

• Search existing issues to avoid duplicities.
• Submit an issue with label bug, or enhancement.
• For a bug, include any relevant information, e.g. task output, installed OS/Node.js/Grunt/grunt-userev versions, and steps to reproduce.

Submit a pull request

• Fork the repository (help) and checkout new branch prefixed with either feature-, or fix-, or docs-, or chore-.
• Use the popular JavaScript style convention and winning JavaScript style with exception of 100 characters per line. In short, use 2 spaces indent, camelCase names, trailing comma, single quotes, semicolons, sparse spacing, and no trailing whitespace.
• For a bugfix, write a test that exposes the bug and fails before applying your fix. Submit the test alongside the fix.
• For a new feature, add tests that cover the feature.
• Lint and test your code by running grunt, or grunt watch to watch source files and run tests on any change.
• Use commit messages suitable for generating changelog and following Karma/Angular commit message convention (docs). In short, use <type>(<scope>): <subject> header in imperative present tense, message body describing motivation/differences, and footer referencing related issues and breaking changes.
• Create a pull request (help) to grunt-userev master branch.

License

Copyright 2013 Salsita Software. Licensed under the MIT License.