README.md

@extensionengine/stylelint-config

This package provides Extension Engine's extensible Stylelint config.

Usage

Package contains two shared Stylelint configs:

@extensionengine/stylelint-config

This is default configuration supporting css, scss and Vue.

@extensionengine/stylelint-config/base

This is base configuration without Vue specific rules.

Install

Use install-peerdeps

npx install-peerdeps -D @extensionengine/stylelint-config

or the classic way:

npm install --save-dev postcss-html postcss-scss stylelint @extensionengine/stylelint-config

Using @extensionengine/stylelint-config in your project

In your local stylelint.config.js extend this configuration

'use strict';

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

If you don't need Vue you can use base configuration:

'use strict';

module.exports = {
  extends: '@extensionengine/stylelint-config/base'
};

Check stylelint documentation for rules explanation.

Badge

If you are using this config in your project you can include this badge in a readme to let people know that your code is using it.

[![style @extensionengine style](https://badgen.net/badge/stylelint/@extensionengine/black)](https://github.com/ExtensionEngine/stylelint-config)