README

@ackmann-dickenson/stylelint-config

Extends stylelint-config-standard. Turns on additional rules to enforce A&D style conventions.

Installation

$ npm install --save-dev stylelint @ackmann-dickenson/stylelint-config

Usage

After installing both stylelint and the configuration packages set your .stylelintrc.js config file to:

module.exports = {
  extends: '@ackmann-dickenson/stylelint-config'
};

Your build process will vary based on the tools used in your project.

NPM

{
  "scripts": {
    "lint:styles": "stylelint '**/*.{css,scss}'"
  }
}

$ npm run lint:styles

Gulp

$ npm install --save-dev gulp gulp-stylelint

var gulp = require('gulp');
var gulpStylelint = require('gulp-stylelint');

gulp.task('lint:styles', function() {
  return gulp
    .src('**/*.scss')
    .pipe(
      gulpStylelint({
        reporters: [{ formatter: 'string', console: true }]
      })
    );
});

$ gulp lint:styles

Rules

To see everything that this config adds please refer to the rules documentation.

Usage no npm install needed!