valeriansaliou / gulp-minify-css-names

:mushroom: Gulp plugin to minify CSS classes and CSS IDs

gulp-minify-css-names

Gulp plugin to minify CSS classes and CSS IDs.

Forked from: gulp-minify-cssnames from @Connormiha.

Usage

Minifying all names(class, id) with some postfix (default: '-post-').

Example

We have css file:

.-pre-menu-post- {color: red;}
.-pre-menu_top-post- {color: black;}
.-pre-menu_item-post- {color: green;}
.-pre-menu_item_active-post- {color: blue;}
.-pre-menu_item_active-post-::before {content: 'active'}

var gulp = require('gulp');
var gulpMinifyCssNames = require('gulp-minify-css-names');

gulp.task('minify-css-names', function() {
    return gulp.src(['src/*.css'])
        .pipe(gulpMinifyCssNames())
        .pipe(gulp.dest('build'))
});

Result

.a0 {color: red;}
.a1 {color: black;}
.a2 {color: green;}
.a3 {color: blue;}
.a3::before {content: 'active'}

Example2

Our project has 3 files:

style.css

.-pre-menu-post- {color: red;}
.-pre-menu_top-post- {color: black;}
.-pre-menu_item-post- {color: green;}
.-pre-menu_item_active-post- {color: blue;}
.-pre-menu_item_active-post-::before {content: 'active'}

index.html

<div class="menu-post-" id="-pre-main-menu-post-">
    <div class="menu_item-post-">1</div>
    <div class="menu_item-post-">2</div>
    <div class="menu_item-post- .-pre-menu_item_active-post-">3</div>
</div>

app.js

var $menuItems =  document.querySelectorAll('.-pre-menu_item-post-');
var $mainMenu = document.querySelector('#-pre-main-menu-post-');

Gulp task

var gulp = require('gulp');
var gulpMinifyCssNames = require('gulp-minify-css-names');

gulp.task('minify-css-names', function() {
    return gulp.src(['src/style.css', 'src/index.html', 'src/app.js'])
        .pipe(gulpMinifyCssNames())
        .pipe(gulp.dest('build'))
});

Result

style.css

.a0 {color: red;}
.a1 {color: black;}
.a2 {color: green;}
.a3 {color: blue;}
.a3::before {content: 'active'}

index.html

<div class="a0" id="a4">
    <div class="a2">1</div>
    <div class="a2">2</div>
    <div class="a2 a3">3</div>
</div>

app.js

var $menuItems = document.querySelectorAll('.a2');
var $mainMenu = document.querySelector('#a4');

API

gulp-minify-css-names([options])

options

Type: Object

options.method

Type: String Default: index

CSS names minification method (either index, hash-weak or hash-strong). You may use the non-default hash-* methods to ensure generated class names are always static given the same real class name. This can be useful if you're having cache busting issues between your HTML and CSS (eg. caches out-of-sync). The hash-weak is a smaller 32-bits hash while the hash-strong is a stronger 64-bits hash (use the strong one if you have so many CSS classes that you risk hash collision).

options.prefix

Type: String Default: "-pre-"

Alternative prefix for CSS names. Important: prefix should be valid for CSS class and ID

options.postfix

Type: String Default: "-post-"

Alternative postfix for CSS names. Important: postfix should be valid for CSS class and ID

options.prepend

Type: String Default: "a"

Post-processing: prepend given string to transformed CSS class and ID. Important: prepend should be valid for CSS class and ID

options.append

Type: String Default: ""

Post-processing: append given string to transformed CSS class and ID. Important: append should be valid for CSS class and ID

options.buster

Type: String Default: ""

Hash buster: concatenate the value to hash with given buster value. Can be used to change all hashes at the same time. Requires: method to be a hash method

options.slice

Type: Number Default: -1

Slice minified name: limit the final minified to provided length. This can be used to pick the first values of the hash (removing the last characters) and thus reduce the final size of the CSS file even more. As this reduces entropy on the final values, the collision detector may (or may not) kick in, especially if you have a lot of different CSS names.

Why need a prefix/append?

This plugin match by RegExp in all file/stream content. This will reduce the likelihood of wrong replacement.