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

[Snakemake] Update documentation

Browse source
This commit is contained in:
kpj 2020-09-07 16:37:22 +02:00
parent a171005856
commit 15eec55117
2 changed files with 13 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -74,6 +74,7 @@ Developers on **GitHub** can call the **GitHub Action** to lint their code base
| **Raku** | [Raku](https://raku.org) |
| **Ruby** | [RuboCop](https://github.com/rubocop-hq/rubocop) |
| **Shell** | [Shellcheck](https://github.com/koalaman/shellcheck) / [executable bit check] / [shfmt](https://github.com/mvdan/sh) |
| **Snakemake** | [snakefmt](https://github.com/snakemake/snakefmt/) |
| **SQL** | [sql-lint](https://github.com/joereynolds/sql-lint) |
| **Terraform** | [tflint](https://github.com/terraform-linters/tflint) / [terrascan](https://github.com/accurics/terrascan) |
| **TypeScript** | [eslint](https://eslint.org/) / [standard js](https://standardjs.com/) |
@ -238,6 +239,7 @@ But if you wish to select or exclude specific linters, we give you full control
| **VALIDATE_RAKU** | `true` | Flag to enable or disable the linting process of the Raku language. |
| **VALIDATE_RUBY** | `true` | Flag to enable or disable the linting process of the Ruby language. |
| **VALIDATE_SHELL_SHFMT** | `true` | Flag to enable or disable the linting process of Shell scripts. (Utilizing: shfmt) |
| **VALIDATE_SNAKEMAKE** | `true` | Flag to enable or disable the linting process of Snakefiles. (Utilizing: snakefmt) |
| **VALIDATE_STATES** | `true` | Flag to enable or disable the linting process for AWS States Language. |
| **VALIDATE_SQL** | `true` | Flag to enable or disable the linting process of the SQL language. |
| **VALIDATE_TERRAFORM** | `true` | Flag to enable or disable the linting process of the Terraform language. |

11
docs/disabling-linters.md
View file

@ -48,6 +48,7 @@ For some linters it is also possible to override rules on a case by case level w
- [Raku](#raku)
- [Ruby](#ruby)
- [Shell](#shell)
- [Snakemake](#snakemake)
- [SQL](#sql)
- [Terraform](#terraform)
- [Typescript eslint](#typescript-eslint)
@ -1120,6 +1121,16 @@ shfmt [supports EditorConfig files for configuration](https://github.com/mvdan/s
---
## Snakemake
- [snakefmt](https://github.com/snakemake/snakefmt/)
### snakefmt configuration
- Check the repository's README
---
## SQL
- [SQL](https://www.npmjs.com/package/sql-lint)