@waldronmatt/stylelint-config

1.2.18 • Public • Published

Stylelint Config

My personal shareable stylelint configuration.

Install

yarn add -D stylelint @waldronmatt/stylelint-config

Usage

.stylelintrc.js

CSS

module.exports = {
  extends: '@waldronmatt/stylelint-config',
};

SCSS

module.exports = {
  extends: '@waldronmatt/stylelint-config/scss',
};

Extending

An example configuring a mixed CSS/SCSS configuration.

.stylelintrc.js

module.exports = {
  // ignore linting in dist bundle output folder
  ignoreFiles: ['dist/**'],
  extends: '@waldronmatt/stylelint-config/scss',
  overrides: [
    {
      files: ['**/*.css'],
      extends: '@waldronmatt/stylelint-config',
    },
  ],
};

Add an NPM Script

Running this command:

npm set-script lint:css "stylelint --fix **/*.{css,scss}"

Will create:

package.json

"scripts": {
  "lint:css": "stylelint --fix **/*.{css,scss}"
},

Add a Pre-commit Hook

lint-staged.config.js

module.exports = {
  '*.{css,scss}': ['prettier --cache --write', 'stylelint --cache --fix'],
};

Under The Hood

index.js

  • Plugins
    • stylelint-order
    • stylelint-no-unsupported-browser-features
    • stylelint-high-performance-animation
  • Extends
    • stylelint-config-standard
    • stylelint-a11y
    • stylelint-prettier

scss.js

  • Plugins
    • stylelint-order
    • stylelint-no-unsupported-browser-features
    • stylelint-high-performance-animation
  • Extends
    • stylelint-config-standard-scss
    • stylelint-config-sass-guidelines
    • stylelint-a11y
    • stylelint-prettier

License

MIT

Package Sidebar

Install

npm i @waldronmatt/stylelint-config

Weekly Downloads

1

Version

1.2.18

License

MIT

Unpacked Size

6.59 kB

Total Files

6

Last publish

Collaborators

  • waldronmatt