base-configs/packages/stylelint-config

@ivuorinen/stylelint-config

ivuorinen's shareable configuration for stylelint.

Table of Contents

• Installation
• Usage
  • CSS _^(Default)
  • SCSS
• Extending the config
• Documentations
• Contributing
• Changelog
• License

Installation

Install this config as a devDependencies:

# npm
npm install @ivuorinen/stylelint-config --save-dev

# Yarn
yarn add @ivuorinen/stylelint-config --dev

After installing it, a .stylelintrc.json file will be created automatically in the project's root folder with the following configuration:

{
  "extends": ["@ivuorinen/stylelint-config/css"]
}

Usage

This package provides configuration for CSS and SCSS, you can choose which one you want to extend:

CSS _^(Default)

{
  "extends": ["@ivuorinen/stylelint-config/css"]
}

SCSS

{
  "extends": ["@ivuorinen/stylelint-config/scss"]
}

Extending the config

The defined rules can be modified by adding other configurations, plugins or custom rules:

{
  "extends": ["@ivuorinen/stylelint-config/css", "some-other-config-you-use"],
  "rules": {
    "at-rule-no-unknown": [
      true,
      {
        "ignoreAtRules": ["extends", "ignores"]
      }
    ]
  }
}

Documentations

Read the stylelint docs for more information.

Contributing

If you are interested in helping contribute, please take a look at our contribution guidelines and open an issue or pull request.

Changelog

See CHANGELOG for a human-readable history of changes.

License

Distributed under the MIT License. See LICENSE for more information.