grunt-revizor v0.1.0

grunt-revizor

Grunt plugin for compression CSS classes and identifiers. Exmaple: .b-tabmenu--item__active-- -> .zS, #success_info-- -> .e6

Getting Started

This plugin requires Grunt ~0.4.5

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

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

grunt.loadNpmTasks('grunt-revizor');

Options

options.namePrefix

Type: String Default value: '--'

Prefix to which end the class names and identifiers to be compressed Exmaple: .b-tabmenu--item__active-- -> .zS

options.compressFilePrefix

Type: String Default value: '-min'

The prefix for the name of the compressed file. The final name of the new file is equal to the original file name plus a prefix plus the extension of the original file. Example: style1.css -> style-min.css

options.flatten

Type: Boolean Default value: true

Set false if you want to save the directory structure

Usage Examples

Default Options

grunt.initConfig({
  revizor: {
    options: {},
    src: ['test/css/*.css', 'test/html/*.html', 'test/js/*.js']
  },
});

The result is a new compressed files in the same directory specified in the src, with a standard prefix. Name compress example: .b-tabmenu--item__active-- -> .zS Example: test/css/style1-min.css, test/css/style2-min.css, test/html/index-min.html

Custom Options

Save all compressed files in a single directory

grunt.initConfig({
  revizor: {
    options: {},
    src: ['test/css/*.css', 'test/html/*.html', 'test/js/*.js'],
    dest: 'build/'
  },
});

The result is a new compressed files in the directory build, with a standard prefix. Example: build/style1-min.css, build/style2-min.css, build/index-min.html

Save directory tree

grunt.initConfig({
  revizor: {
    options: {
        flatten: false
    },
    src: ['test/css/*.css', 'test/html/*.html', 'test/js/*.js'],
    dest: 'build/'
  },
});

The result is a new compressed files in the directory build, with a standard prefix. Example: build/test/css/style1-min.css, build/test/css/style2-min.css, test/html/index-min.html

Custom namePrefix and filePrefix

grunt.initConfig({
  revizor: {
    options: {
        namePrefix: '__',
        compressFilePrefix: '.min'
    },
    src: ['test/css/*.css', 'test/html/*.html', 'test/js/*.js'],
    dest: 'build/'
  },
});

The result is a new compressed files in the directory build, with the prefix .min. Will compress all names that end with symbols __. Name compress example: .b-tabmenu__item--active__ -> .xS File path example: build/style1.min.css, build/style2.min.css, build/index.min.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.

Release History

• 2015-02-02   v0.1.0   Initial release.