Skip to content
This repository was archived by the owner on Jun 4, 2025. It is now read-only.

team23/stylelint-config-team23-scss

Repository files navigation

stylelint-config-team23-scss

Standard SCSS linting config for TEAM23

Rules for linting CSS + SCSS at TEAM23 with stylelint.

Extends stylelint-config-team23-standard, which enables css error checking based on best practices. So if you want to lint css and scss styles, you just need this configuartion, as it includes the stylelint-config-team23-standard configuration.

It further extends stylelint-config-standard-scss which enables scss error checking plus some style checking rules. the stylechecking rules are disabled by also extending stylelint-config-prettier-scss. Our custom ruleset is defined in the index.js.

⚠️ Important Notice: Migration to Monorepo ⚠️

🚨 This package has been moved to a monorepo! 🚨

As of 04.06.2025, the project has been migrated to a monorepo structure. You can now find the project at the following location:

🔗 Monorepo Path: https://github.com/team23/style-guide/tree/main/libs/scss

This move allows us to better manage shared code and collaborate efficiently. Please make sure to update your references to the new monorepo structure.

If you encounter any issues or have questions, please open an issue in the new monorepo repository.

Installation

npm:

# latest version
npm install --save-dev @team23/stylelint-config-team23-scss

# specific version
npm install --save-dev @team23/[email protected]

Usage

If you've installed stylelint-config-team23-scss locally within your project, just set your stylelint config to:

{
    "extends": "@team23/stylelint-config-team23-scss"
}

If you use a version prior to v1.0.2, use

{
    "extends": "stylelint-config-team23-standard"
}

Extending the config

Simply add a "rules" key to your config, then add your overrides and additions there.

For example, to change the at-rule-no-unknown rule to use its ignoreAtRules option, change the indentation to tabs, turn off the number-leading-zero rule,and add the unit-whitelist rule:

{
    "extends": "@team23/stylelint-config-team23-scss",
     "rules": {
         "scss/at-extend-no-missing-placeholder": true,
         # ...
     }
}

Proposing rule changes

For proposing changes to the ruleset please open either

  • a merge request
  • a ticket

About

Additional stylelint config for linting SCSS at TEAM23

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •