Skip to content

Latest commit

 

History

History
116 lines (87 loc) · 3.93 KB

README.md

File metadata and controls

116 lines (87 loc) · 3.93 KB
Raw

grunt-htmlurlrev

Change asset paths inside html files based on output from grunt-filerev, grunt-hashmap, or other similar plugins

Created from grunt-cssurlrev, from Richard Bolt & Theo Ephraim who deserve all the credit for this module, as i just managed to handle html files and parse tags

Getting Started

This plugin requires Grunt >=0.4.0

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-htmlurlrev --save-dev

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

grunt.loadNpmTasks('grunt-htmlurlrev');

The "htmlurlrev" task

Overview

This plugin will replace file urls within html files to be compatible with static asset versioning plugins -- plugins that rename your files based on a short hash of the file contents (for cache busting purposes).

The two that are directly compatible are grunt.filerev and grunt.hashmap, but most others will probably work as well, as long as they output a json file of lookups from original filenames to the new filename or just it's hash.

Please note that it modifies files in place at present.

Creating the htmlurlrev task

In your project's Gruntfile, add a section named htmlurlrev to the data object passed into grunt.initConfig().

grunt.initConfig({
  htmlurlrev: {
    options: {
      assets: 'path/to/assets.json'
    },
    your_target: {
      src: ['public/views/*.html']
    },
  },
})

Options

options.assets

Type: String Default value: null

A file path that is used to load a json object from. If empty (default), then grunt.filerev.summary is used to modify url paths.

options.prefix

Type: String Default value: null

A prefix to add to each url as it is replaced. Useful for complex build processes where files are moved around after revving.

options.hashmap_rename

Type: String or Boolean Default value: null

This option enables compatibility with grunt.hashmap. If set to true, the default renaming scheme will be used. Otherwise, it should be set to the same naming scheme used for grunt.hashmap. It makes sense to use a template tag to use it directly (see example below).

Usage Examples

Default Options

In this example, files matching public/views/*.html are modified to have any links to assets modified with grunt.filerev.summary updated.

grunt.initConfig({
  htmlurlrev: {
    files: {
      src: ['public/views/*.html'],
    },
  },
})

Hashmap Example

This example shows how to use it with grunt.hashmap and a more customized file renaming scheme.

grunt.initConfig({
  hashmap: {
    options: {
      output: 'assets/hashmap.json',
      rename: '#{= dirname}/#{= hash}.#{= basename}#{= extname}',
      keep: false,
      hashlen: 6
    },
    all: {
      cwd: 'public',
      src: '**/*.{css,js,pdf,eps,png,jpg,jpeg,gif,eot,svg,ttf,woff}',
      dest: 'public'
    }
  },
  htmlurlrev: {
    options: {
      assets: '<%= hashmap.options.output %>',
      hashmap_rename: '<%= hashmap.options.rename %>'
    },
    files: {
      src: ['public/views/*.html'],
    },
  },
})

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.