grunt-css-prefix v0.2.3

grunt-css-prefix 0.2.3

prefixing css using rework

Getting Started

This plugin requires Grunt ~0.4.1

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-css-prefix --save-dev

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

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

The "css_prefix" task

Overview

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

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

Options

options.prefix

Type: String Default value: ''

Prefix any class name in the target file with this prefix.

options.strip

Type: String Default value: ''

Strip any class name from a given string.

options.processName

Type: String Default value: 'dasherize'

process the prefixed class name with any of underscore.string methods

options.separator

Type: String Default value: ', '

A string value that is used to do something with whatever.

options.punctuation

Type: String Default value: '.'

A string value that is used to do something else with whatever else.

Usage Examples

Default Options

In this example, we'll prefix all classes with libname-, also each class name will be dasherized so className will become class-name.

grunt.initConfig({
  css_prefix: {
    thirdparty: {
      options: {
        prefix: 'libname-',
        strip: 'legacy-'      
      },
      files: {
        'dest/style.css': ['css/style.css']
      }
    }
  }
})

• style.css before:

.foo,
.Bar,
.legacy-thing,
h1 {
  display: none;
}

• style.css after:

.libname-foo,
.libname-bar,
.libname-thing,
h1 {
  display: none;
}

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

• 0.1.0: basic prefix usage
• 0.1.2: tested with node unit
• 0.2.0: added strip option / fixes prefix
• 0.2.1: fixed dependencies in package.json