Skip to content
This repository has been archived by the owner on Mar 30, 2024. It is now read-only.

Shareable stylelint configuration for Pangolin.js projects.

License

Notifications You must be signed in to change notification settings

pangolinjs/stylelint-config

Repository files navigation

Pangolin.js stylelint config

Shareable stylelint config for Pangolin.js based on stylelint-config-sass-guidelines.

The class name pattern follows the Suit CSS naming convention.

Installation

Install the configuration and all peer dependencies with one command:

npm install --save-dev @pangolinjs/stylelint-config stylelint

Usage

Create a config

Create a stylelint configuration either as a JSON or a JavaScript file:

.stylelintrc.json

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

stylelint.config.js

module.exports = {
  extends: [
    '@pangolinjs/stylelint-config'
  ]
}

Modifying config and rules

Overwrite rules from the default config:

JSON configuration file

{
  "extends": [
    "@pangolinjs/stylelint-config"
  ],
  "rules": {
    "number-leading-zero": false
  }
}

JavaScript configuration file

module.exports = {
  extends: [
    '@pangolinjs/stylelint-config'
  ],
  rules: {
    'number-leading-zero': false
  }
}

stylelint has an extensive list of rules. Additional rules are provided by the following plugins: