mirror of
https://github.com/actions-hub/stylelint.git
synced 2024-11-26 01:31:01 -05:00
48 lines
938 B
Markdown
48 lines
938 B
Markdown
# stylelint
|
|
GitHub Action that runs [stylelint](https://stylelint.io).
|
|
|
|
## Usage
|
|
|
|
```yaml
|
|
- uses: exelban/stylelint@master
|
|
```
|
|
|
|
Or use docker image:
|
|
```yaml
|
|
- uses: "docker://exelban/stylelint:latest"
|
|
```
|
|
|
|
### Default values
|
|
#### Configuration file
|
|
Action will check if stylelint is already installed. If not, it will install stylelint.
|
|
Also, its check if the configuration file exists (`.stylelintrc`).
|
|
|
|
By default action use next configuration:
|
|
```json
|
|
{
|
|
"extends": "stylelint-config-standard",
|
|
"rules": {
|
|
"indentation": 2
|
|
}
|
|
}
|
|
```
|
|
|
|
#### Pattern
|
|
If pattern is not provided, action will use default one: `*.css`.
|
|
```yaml
|
|
- uses: exelban/stylelint@master
|
|
with:
|
|
args: ./**/*.scss
|
|
```
|
|
|
|
#### Indentation
|
|
Indentation can be set by environment variable `INDENT_SPACES`.
|
|
|
|
```yaml
|
|
- uses: exelban/stylelint@master
|
|
env:
|
|
INDENT_SPACES: 4
|
|
```
|
|
|
|
## License
|
|
[MIT License](https://github.com/exelban/stylelint/blob/master/LICENSE)
|