gulp-obfuscate-selectors v0.3.0

Fork of https://github.com/cazzer/gulp-selectors

gulp-obfuscate-selectors

Minify those pesky selector names down to nothing with this fancy gulp plugin. Minified selectors will be applied consistently across all files piped into it.

You're like: .some-super-descriptive-selector-name {...}, and it's like: .a {...}

Usage

First and foremost: npm install gulp-obfuscate-selectors

var gulp = require('gulp');
var gs  = require('gulp-obfuscate-selectors');

gulp.src(['src/**/*.css', 'src/**/*.html', 'src/**/*.js'])
    .pipe(gs.run())
    .pipe(gulp.dest('dist'));

You can also pass some options into run:

gs.run(processors, ignores)

Defaults

All arguments are optional. If omitted, processors will default to css and html and ignores will be empty:

gs.run({
    'css': ['css'],
    'html': ['html'],
    'js': ['js']
  }, {
  });

Advanced Usage

var processors = {
        'css':  ['scss', 'css'],        // run the css processor on .scss and .css files
        'html': ['haml'],               // run the html processor on .haml files
        'js':   ['js']                  // run the js plugin on js files
    },
    ignores = {
        classes: ['hidden', 'active']   // ignore these class selectors,
        ids: '*'                        // ignore all IDs
    };

gs.run(processors, ignores);

Two processors are built in for your convenience: css and html are stable but js and remove-unused are beta and may be moved to their own repositories.

• css: matches .selectors and #selectors
• html: matches id="selector"s, class="selector"s, and for="selector"s
• js: matches .selectors and #selectors
• remove-unused: should be run last, and only on stylesheets - it removes all declarations present in the library which haven't been used

If a processor is listed which isn't built in, gulp-obfuscate-selectors will attempt to require it.

How gulp-obfuscate-selectors works

Calling gs.run() builds a library which persists for all processors used in the call. Processors are run on all associated files and all selectors, besides those that have been ignored, will be minified.

Processors

{
    'css': ['css', 'scss'],
    'html': ['html', 'tpl.js'],
    'js': ['js', '!tpl.js'],
    'your-custom-processor': ['.ext']
}

css, html and js are built in. Additional processors referenced will be injected where needed so it is important to ensure all are installed. Processors are used like this:

processor(file, classLibrary, idLibrary)

File is the string containing the file contents. Each of the two libraries exposes the following API:

• set(selectorName): returns a minified selector name
• has(selectorName): tests if the name exists
• get(selectorName, dontCount): ...

libraries

Ignores

{
    ids: ['content', 'target'],
    classes: ['hidden', 'active']
}