grunt-cssurlrev
v1.0.1
Published
Change asset paths inside css files based on output from grunt-filerev, grunt-hashmap, or other similar plugins
Downloads
2,986
Readme
grunt-cssurlrev
Change asset paths inside css files based on output from grunt-filerev, grunt-hashmap, or other similar plugins
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-cssurlrev --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-cssurlrev');
The "cssurlrev" task
Overview
This plugin will replace file urls within css 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 cssurlrev task
In your project's Gruntfile, add a section named cssurlrev
to the data object passed into grunt.initConfig()
.
grunt.initConfig({
cssurlrev: {
options: {
assets: 'path/to/assets.json'
},
your_target: {
src: ['public/css/*.css']
},
},
})
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/css/*.css
are modified to have any links to assets modified with grunt.filerev.summary
updated.
grunt.initConfig({
cssurlrev: {
files: {
src: ['public/css/*.css'],
},
},
})
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'
}
},
cssurlrev: {
options: {
assets: '<%= hashmap.options.output %>',
hashmap_rename: '<%= hashmap.options.rename %>'
},
files: {
src: ['public/css/*.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.