turmag-stylelint-config

Turmag's reusable stylelint-config

Languages

Web

• Scss: stylelint-config-standard + stylelint-config-recommended + stylelint-config-recommended-scss + stylelint-config-recommended-vue
• Vue: stylelint-config-standard + stylelint-config-recommended + stylelint-config-recommended-scss + stylelint-config-recommended-vue + postcss-html

Features

Zero-Dependency No need to install 6 plugins and 2 parsers: each language's latest plugin is bundled and configured.

Zero-Config No need to remember each plugin's parserOptions;

Installation

1. You'll first need to install Stylelint:

npm i stylelint@^16.11 --save-dev

# Or run this to use yarn
yarn add stylelint@^16.11 --dev

# Or run this to use pnpm
pnpm add stylelint@^16.11 --save-dev

2. Install turmag-stylelint-config.

npm i turmag-stylelint-config --save-dev

# Or run this to use yarn
yarn add turmag-stylelint-config --dev

# Or run this to use pnpm
pnpm add turmag-stylelint-config --save-dev

3. Create stylelint.config.js in your project root.

Usage

In stylelint.config.js:

• Import config from turmag-stylelint-config

import config from 'turmag-stylelint-config';

• Use this config with your optional rules:

export default {
    extends: ['turmag-stylelint-config'],

    // Your rules there
    rules: {
        ...
    },
};

License

This code is licensed under the MIT License.