ajmichels / grunt-uniqueify

Rename files using a content hash then replace references to that file in source code.

grunt-uniqueify

Rename files using a content hash then replace references to that file in source code.

Getting Started

This plugin requires Grunt ~0.4.4

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

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

grunt.loadNpmTasks('grunt-uniqueify');

The "uniqueify" task

Overview

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

grunt.initConfig({
  uniqueify: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
});

Options

options.replaceSrc

Type: Array Default value: null

Locations that should be inspected for references to the files being renamed.

Usage Examples

Default Options

In this example the JS and CSS files in the specified directories will be renamed.

grunt.initConfig({
  uniqueify: {
    files: {
      src: ['src/testing/*.js', 'src/123/*.css'],
    },
  },
});

Custom Options

In this example the JS and CSS files in the specified directories will be renamed and any references to the original names in any .html files will be replaced with the new names.

grunt.initConfig({
  uniqueify: {
    options: {
      replaceSrc: ['src/**/*.html']
    },
    files: {
      src: ['src/testing/*.js', 'src/123/*.css'],
    },
  },
});

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.

Release History

(Nothing yet)