⚠This package will be DEPRECATED⚠
⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠
stylelint-plugin-stylus has been renamed to stylelint-stylus.
stylelint-plugin-stylus is an alias for stylelint-stylus.
We recommend using stylelint-stylus directly.
⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠⚠
stylelint-plugin-stylus
Stylelint plugin for Stylus.
This plugin is still in an experimental state
## :name_badge: Introduction
[Stylelint] plugin for [Stylus].
This plugin allows us to check the [Stylus] with [Stylelint].
- Finds the many wrong use of selector, declaration, at-rule and more using the rules of [Stylelint].
- Finds the violations in coding style for [Stylus].
- Use the [fix option] to automatically fixes the many stylistic violations.
[fix option]: https://stylelint.io/user-guide/usage/options#fix
[Stylelint editor integrations](https://stylelint.io/user-guide/integrations/editor) are useful to check your code in real-time.
You can check on the [Online DEMO](https://stylus.github.io/stylelint-stylus/playground/).
## :cd: Installation
Via [npm]:
```bash
npm install --save-dev stylelint stylelint-plugin-stylus
```
## :book: Usage
`stylelint-plugin-stylus` is a plugin for [Stylelint], so it is for use with [Stylelint].
If you are not using [Stylelint], start by using [Stylelint].
### Configuration
Use `.stylelintrc.*` or `stylelint.config.js` file to configure rules. See also: [https://stylelint.io/user-guide/configure](https://stylelint.io/user-guide/configure).
Example **stylelint.config.js**:
```js
module.exports = {
extends: [
// add more generic rulesets here, such as:
// "stylelint-config-standard",
"stylelint-plugin-stylus/standard",
],
rules: {
// override/add rules settings here, such as:
// "stylus/declaration-colon": "never"
},
};
```
If you want to set all the rules yourself, set as follows.
```js
module.exports = {
plugins: [
// add this plugin here:
"stylelint-plugin-stylus",
],
// makes the stylus files parseable.
overrides: [
{
files: ["*.stylus", "*.styl", "**/*.stylus", "**/*.styl"],
customSyntax: "postcss-styl",
},
],
rules: {
// add rules settings here, such as:
"stylus/declaration-colon": "never",
"stylus/pythonic": "always",
"stylus/selector-list-comma": "never",
"stylus/semicolon": "never",
"stylus/single-line-comment": "always",
},
};
```
## :computer: Editor integrations
### Visual Studio Code
Use the [stylelint.vscode-stylelint](https://marketplace.visualstudio.com/items?itemName=stylelint.vscode-stylelint) extension that [Stylelint] provides officially.
You have to configure the `stylelint.validate` option of the extension to check `.stylus` files, because the extension does not check the `*.stylus` file by default.
Example **.vscode/settings.json**:
```jsonc
{
"stylelint.validate": [
...,
// ↓ Add "stylus" language.
"stylus"
]
}
```
### Custom Syntax
**If you are using stylelint v13, you need to do the following:**
Set [custom syntax](https://stylelint.io/user-guide/usage/options#customsyntax) for parsing [Stylus]. With the following setting, `.styl` and `