PostHTML-classes

PostHTML-plugin to retrieve a list of classes from html file(s) with support of nested structure (PostCSS, Stylus, SASS, SCSS, LESS)

Install

$ npm install --save-dev posthtml-classes

Usage

var posthtml = require('posthtml'),
    config = {
        fileSave: true,
        filePath: './classList.css',
        overwrite: false,
        eol: '\n',
        nested: false,
        curlbraces: true,
        elemPrefix: '__',
        modPrefix: '_',
        modDlmtr: '_'
    },
    html = '<div block="mad-tea-party"><div elem="march-hare" mods="type:mad">March Hare</div><div elem="hatter" mods="type:mad">Hatter</div><div elem="dormouse" mods="state:sleepy">Dormouse</div></div>';

posthtml()
    .use(require('posthtml-classes')(config))
    .process(html);
    //classList.css
    //.mad-tea-party {}
    //.mad-tea-party__march-hare {}
    //.mad-tea-party__march-hare_type_mad {}
    //.mad-tea-party__hatter {}
    //.mad-tea-party__hatter_type_mad {}
    //.mad-tea-party__dormouse {}
    //.mad-tea-party__dormouse_state_sleepy {}

or with support of nested structure

var posthtml = require('posthtml'),
    config = {
        fileSave: true,
        filePath: './classList.css',
        overwrite: false,
        eol: '\n',
        nested: false,
        curlbraces: true,
        elemPrefix: '__',
        modPrefix: '_',
        modDlmtr: '_'
    },
    html = '<div class="animal"><div class="animal__nose animal__nose_size_long elephant__trunk elephant__trunk_size_short elephant__trunk_color_brown">Nose</div></div>';

posthtml()
    .use(require('posthtml-classes')(config))
    .process(html);
    //classList.css
<!-- .animal {
        &__nose {
            &_size_long {}
        }
     }
     .elephant {
        &__trunk {
            &_size_short {}
            &_color_brown {}
        }
     }
-->

Options

fileSave

Type: boolean
Default: true

Set true if you want to save the file, or false if you want to copy to clipboard (Mac/Win/Linux).

filePath

Type: string
Default: ./classList.css

The filename and path of the saved file

overwrite

Type: boolean
Default: false

Set true if you want to save to the same file - the data in this file will be overwritten, or false if you want to save to a different file each time - the file will be have random id (i.e. classList_0394.css)

eol

Type: string
Default: \n

Characters that are added to the end of the CSS rule

nested

Type: boolean
Default: false

Set true if you want to generate css file with support of nested structure, which supported by PostCSS, Stylus, SCSS or LESS preprocessor, or false if you want to generate standard css.

curlybraces

Type: boolean
Default: true

Set true if you want to use curly braces, or false if you want to generate without them, for example for SASS or Stylus

elemPrefix

Type: string
Default: __

Characters that can be used for delimiter of element

modPrefix

Type: string
Default: _

Characters that can be used for delimiter of modifiers

modDlmtr

Type: string
Default: _

Characters that can be used for the separator modifier values

With Gulp

var gulp = require('gulp'),
    posthtml = require('gulp-posthtml');

gulp.task('default', function () {
    return gulp.src('test.html')
        .pipe(posthtml([
            require('posthtml-classes')({
                fileSave: true,
                filePath: './classList.css',
                overwrite: false,
                eol: '\n',
                nested: false
            })
        ]));
});

License

MIT