https://github.com/wikimedia/stylelint-config-wikimedia
CSS/Less Stylelint configuration according to CSS coding conventions for Wikimedia.
https://github.com/wikimedia/stylelint-config-wikimedia
code coding-standards css less linting style stylelint wikimedia
Last synced: 2 months ago
JSON representation
CSS/Less Stylelint configuration according to CSS coding conventions for Wikimedia.
- Host: GitHub
- URL: https://github.com/wikimedia/stylelint-config-wikimedia
- Owner: wikimedia
- License: mit
- Created: 2016-05-17T16:46:03.000Z (about 9 years ago)
- Default Branch: main
- Last Pushed: 2025-01-07T14:39:32.000Z (5 months ago)
- Last Synced: 2025-04-02T11:05:17.564Z (2 months ago)
- Topics: code, coding-standards, css, less, linting, style, stylelint, wikimedia
- Language: JavaScript
- Homepage: https://www.mediawiki.org/wiki/Manual:Coding_conventions/CSS
- Size: 1.1 MB
- Stars: 14
- Watchers: 15
- Forks: 9
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Support: support-basic-rules.js
Awesome Lists containing this project
README
# stylelint-config-wikimedia
[](https://www.npmjs.org/package/stylelint-config-wikimedia)
> Wikimedia CSS Coding Standards shareable config for stylelint
Configuration rules to ensure your CSS is compliant with the [Wikimedia CSS Coding Standards](https://www.mediawiki.org/wiki/Manual:Coding_conventions/CSS).
## Installation
```console
$ npm install -D stylelint-config-wikimedia
```
## Usage
Set your `stylelint` config file, `.stylelintrc.json`, to:
```json
{
"extends": "stylelint-config-wikimedia"
}
```
If you would also like to enable rules to disallow CSS which is unsupported by modern browsers [Grade A](https://www.mediawiki.org/wiki/Compatibility#Modern_(Grade_A)) or basic supported browsers [Grade C](https://www.mediawiki.org/wiki/Compatibility#Basic_(Grade_C)) browsers, you can use the following configurations instead:
```json
{
"extends": "stylelint-config-wikimedia/support-modern"
}
```
```json
{
"extends": "stylelint-config-wikimedia/support-basic"
}
```
If you are using in a MediaWiki environment, you can add the following config:
```json
{
"extends": [
"stylelint-config-wikimedia",
"stylelint-config-wikimedia/mediawiki"
]
}
```
If you need to combine this with browser support rules:
```json
{
"extends": [
"stylelint-config-wikimedia/support-modern",
"stylelint-config-wikimedia/mediawiki"
]
}
```
### Extend or override the configuration
Add a `"rules"` object to your config file, and add your overrides or additional rules there, for example:
```json
{
"extends": "stylelint-config-wikimedia/support-basic",
"rules": {
"@stylistic/max-empty-lines": null
}
}
```
## Changelog
You can read the [changelog](CHANGELOG.md) for release versions.
## License
This is available under the [MIT License](LICENSE).