grunt-css-metrics

grunt-css-metrics
=================

Grunt task to analyse css files and log simple metrics.

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:

``shell
npm install grunt-css-metrics --save-dev
`

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

`js
grunt.loadNpmTasks('grunt-css-metrics');
`


Options

$3

Type: Boolean
Default: false

Supress any warnings thrown by other max count options.

$3

Type: Number
Default: ∞

Maximum CSS file size in bytes

$3

Type: Boolean
Default: ∞

Maximum number of rules within CSS file. (Note: IE selector limit is 4096)

Examples

$3

Basic example of a Grunt config containing the css-metrics task.
`js
grunt.initConfig({
cssmetrics: {
dev: {
src: [
'assets/stylesheets/global.min.css'
]
}
}
});

grunt.loadNpmTasks('grunt-css-metrics');

grunt.registerTask('default', ['cssmetrics']);
`

$3

Running css-metrics against multiple CSS files. All the files specified in the src array will be analyzed by css-metrics.
`js
cssmetrics: {
dist: {
src: [
'assets/stylesheets/global.css',
'assets/stylesheets/head.css',
'assets/stylesheets/*.min.css'
]
}
}
`

$3

Example of using the options.

`js
cssmetrics: {
dev: {
src: [
'test/*.min.css'
],
options: {
quiet: false,
maxRules: 4096,
maxFileSize: 10240000
}
}
}
`

$3

Example of using a glob pattern to target many files that should be analysed by css-metrics. The example below will analyse all the files in the css directory that have an extension of .css.

`js
cssmetrics: {
dist: {
src: ['css/*.css']
}
}
``

Release History

$3

* Initial release

Credits

* @visionmedia for the great css-parse library.
* Original work from @rquinlivan's (css-metrics)[https://github.com/rquinlivan/css-metrics]
* Inspiration from my collegue @kaelig