Warn long URL in CSS files.
This plugin requires Grunt ~0.4.2
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-long-url --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-long-url');
In your project's Gruntfile, add a section named long_url
to the data object passed into grunt.initConfig()
.
grunt.initConfig({
long_url: {
options: {
// Task-specific options go here.
},
your_target: {
// Target-specific file lists and/or options go here.
},
},
});
Type: Number
Default value: 1000
A threshold number for warning. If you set this variable to 0
, task checks only errors.
Type: Number
Default value: 2000
A threshold number for error.
In this example, the default options are used to check URLs in CSS files under src/css/
and their sub-directories. So if a CSS file has a URL more than 1000 characters, Grunt will show warning but continue. And if a CSS file has a long URL more than 2000 characters, Grunt will show error and abort.
grunt.initConfig({
long_url: {
default_options: {
src: ['src/css**/*.css']
}
},
});
This plugin is read-only task, so you don't need to specify dest
like grunt-contrib-jshint
.
In this example, custom options are used to change threshold number for warning and error. So if a CSS file has a URL more than 500 characters, Grunt would show warning but continue. And if a CSS file has a long URL more than 1000 characters, Grunt would show error and abort.
grunt.initConfig({
long_url: {
custom_options: {
options: {
warning: 500,
error: 1000
},
src: ['src/css/**/*.css']
}
},
});
In this example, custom options are used to turn off warnings. So Grunt will not show any warnings. But if a CSS file has a long URL more than 2000 characters, Grunt will show error and abort same as default.
grunt.initConfig({
long_url: {
custom_options: {
options: {
warning: 0
},
src: ['src/css/**/*.css']
}
},
});
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.
- 2013-12-18 v0.1.0 Initial release