actions/lint
1
0
Fork 0
mirror of https://github.com/super-linter/super-linter.git synced 2024-12-23 05:02:15 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

adding yml

Browse source
This commit is contained in:
Lucas Gravley 2020-04-23 07:55:25 -05:00
parent 71c504df18
commit fe18dba9cb
1 changed files with 38 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
docs/disabling-linters.md
View file

@ -8,7 +8,7 @@ Below is examples and documentation for each language and the various methods to
- [Rubocop](https://github.com/rubocop-hq/rubocop) - [Rubocop](https://github.com/rubocop-hq/rubocop)
### Rubocop Config file ### Rubocop Config file
- `.ruby-lint.yml` - `.github/linters/.ruby-lint.yml`
- You can pass multiple rules and overwrite default rules - You can pass multiple rules and overwrite default rules
- File should be located at: `.github/linters/.ruby-lint.yml` - File should be located at: `.github/linters/.ruby-lint.yml`
- **Note:** We use the Default **GitHub** Rule set from [Rubocop-GitHub](https://github.com/github/rubocop-github) - **Note:** We use the Default **GitHub** Rule set from [Rubocop-GitHub](https://github.com/github/rubocop-github)
@ -55,7 +55,7 @@ AllCops:
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
## Shell ## Shell
**Shellcheck** is an opensource tool we use for linting and validation of shell scripting. **Shellcheck** is an opensource tool we use for linting and validation of the shell scripting language.
- [Shellcheck](https://github.com/koalaman/shellcheck) - [Shellcheck](https://github.com/koalaman/shellcheck)
### Shellcheck Config file ### Shellcheck Config file
@ -94,10 +94,46 @@ moreThings()
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
## YAML ## YAML
- [YamlLint](https://github.com/adrienverge/yamllint)
### Yamllint Config file ### Yamllint Config file
- `.github/linters/.yaml-lint.yml`
- You can pass multiple rules and overwrite default rules
- File should be located at: `.github/linters/.yaml-lint.yml`
### Yamllint disable single line ### Yamllint disable single line
```yml
This line is waaaaaaaaaay too long # yamllint disable-line
```
### Yamllint disable code block ### Yamllint disable code block
```yml
# yamllint disable rule:colons
- Lorem : ipsum
dolor : sit amet,
consectetur : adipiscing elit
# yamllint enable
```
### Yamllint disable entire file ### Yamllint disable entire file
If you need to ignore an entire file, you can update the `.yaml-lint.yml` to ignore certain files and locations
```yml
# For all rules
ignore: |
*.dont-lint-me.yaml
/bin/
!/bin/*.lint-me-anyway.yaml
rules:
key-duplicates:
ignore: |
generated
*.template.yaml
trailing-spaces:
ignore: |
*.ignore-trailing-spaces.yaml
/ascii-art/*
```
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------