gulp-cssdepth-check v0.3.1

gulp-cssdepth-check

Gulp plugin to check for maximum CSS depth

Usage

First, install gulp-cssdepth-check as a development dependency:

npm install --save-dev gulp-cssdepth-check

Then, add it to your gulpfile.js:

var cssdepth = require('gulp-cssdepth-check');

gulp.task('check-styles-depth', function() {
  gulp.src('src/css/*.css')
    .pipe(cssdepth({
      depthAllowed: 3,
      showStats: true,
      throwError: true
    }));
});

API

cssdepth(options)

options

Type: Object

options.depthAllowed

Type: numeric Default: 3

gulp.src('src/css/*.css')
  .pipe(cssdepth({
    'depthAllowed': 3
  }));

options.showStats

Type: boolean Default: true

Shows the breakdown of Selector Depth and instances that it occurs.

gulp.src('src/css/*.css')
  .pipe(cssdepth({
    'depthAllowed': 3,
    'showStats': true
  }));

Output

[15:25:56] CSS Depth Check Report for desktop.css
[15:25:56]
┌────────────────┬───────────┬──────────┬─────────┐
│ Selector Depth │ Instances │ Previous │  Change │
├────────────────┼───────────┼──────────┼─────────┤
│ 4              │       139 │      149 │  -6.71% │
├────────────────┼───────────┼──────────┼─────────┤
│ 5              │        51 │       61 │ -16.39% │
├────────────────┼───────────┼──────────┼─────────┤
│ 6              │        26 │      126 │ -79.37% │
├────────────────┼───────────┼──────────┼─────────┤
│ 7              │         3 │       13 │ -76.92% │
├────────────────┼───────────┼──────────┼─────────┤
│ 8              │         1 │        1 │      0% │
└────────────────┴───────────┴──────────┴─────────┘

options.showSelectors

Type: boolean Default: false

Include affected selectors in the output, requires showStats to be enabled.

gulp.src('src/css/*.css')
  .pipe(cssdepth({
    'depthAllowed': 3,
    'showStats': true,
    'showSelectors': true
  }));

Output

[15:25:56] CSS Depth Check Report for desktop.css
[15:25:56]
┌────────────────┬───────────┬────────────────────────────────────────────────────────────────────────┐
│ Selector Depth │ Instances │ Previous │  Change │ Selectors                                         │
├────────────────┼───────────┼──────────┼─────────┼───────────────────────────────────────────────────┤
│ 4              │       3   │        6 │ -50.00% │ .Top-nav .Dropdown-menu li a                      │
│                │           │          │         │ .Top-nav .Dropdown-menu li .menuItem-wrapper      │
│                │           │          │         │ .Top-nav .menu-group:hover .Dropdown-menu         │
└────────────────┴───────────┴──────────┴─────────┴───────────────────────────────────────────────────┘

options.logFolder

Type: String Default: none

If log folder is specified, the check will generate JSON file with stats and selector list.

gulp.src('src/css/*.css')
  .pipe(cssdepth({
    'depthAllowed': 3,
    'showStats': true,
    'showSelectors': true,
    'logFolder': 'target/checks'
  }));

options.throwError

Type: boolean Default: false

You can set throwError to tell gulp that css depth checks validated to error.

gulp.src('src/css/*.css')
  .pipe(cssdepth({
    'depthAllowed': 3,
    'showStats': true,
    'showSelectors': true,
    'logFolder': 'target/checks',
    'throwError': true
  }));