mirror of
https://github.com/super-linter/super-linter.git
synced 2024-12-22 20:52:12 -05:00
commit
08bb027485
1 changed files with 20 additions and 15 deletions
35
README.md
35
README.md
|
@ -2,21 +2,23 @@
|
|||
This repository is for the **GitHub Action** to run a **Super-Linter**.
|
||||
Developers on **GitHub** can call this Action to lint their code base with the following list of linters:
|
||||
|
||||
- **Ruby** (Rubocop)
|
||||
- **Shell** (Shellcheck)
|
||||
- **Ansible** (Ansible-lint)
|
||||
- **YAML** (Yamllint)
|
||||
- **Python3** (Pylint)
|
||||
- **JSON** (JsonLint)
|
||||
- **MarkDown** (Markdownlint)
|
||||
- **Perl** (Perl)
|
||||
- **XML** (LibXML)
|
||||
- **Coffeescript** (coffeelint)
|
||||
- **Javascript** (eslint)(standard)
|
||||
- **Typescript** (eslint)(standard)
|
||||
- **Golang** (golangci-lint)
|
||||
- **Dockerfile** (dockerfilelint)
|
||||
- **Terraform** (tflint)
|
||||
| *Language* | *Linter* |
|
||||
|---|---|
|
||||
| **Ruby** | Rubocop |
|
||||
| **Shell** | Shellcheck |
|
||||
| **Ansible** | Ansible-lint |
|
||||
| **YAML** | Yamllint |
|
||||
| **Python3** | Pylint |
|
||||
| **JSON** | JsonLint |
|
||||
| **MarkDown** | Markdownlint |
|
||||
| **Perl** | Perl |
|
||||
| **XML** | LibXML |
|
||||
| **Coffeescript** | coffeelint |
|
||||
| **Javascript** | eslint standard |
|
||||
| **Typescript** | eslint standard |
|
||||
| **Golang** | golangci-lint |
|
||||
| **Dockerfile** | dockerfilelint |
|
||||
| **Terraform** | tflint |
|
||||
|
||||
## How to use
|
||||
To use this **GitHub** Action you will need to complete the following:
|
||||
|
@ -152,6 +154,9 @@ You can use the **GitHub** **Super-Linter** *with* or *without* your own persona
|
|||
- Copy **any** or **all** template rules files from `TEMPLATES/` into your repository in the location: `.github/linters/` of your repository
|
||||
- If your repository does not have rules files, they will fall back to defaults in this repositories `TEMPLATE` folder
|
||||
|
||||
## Disabling rules
|
||||
If you need to disable certain *rules* and *functionality*, you can view [Disable Rules](https://github.com/github/super-linter/blob/master/docs/disabling-linters.md)
|
||||
|
||||
## Docker Hub
|
||||
The **Docker** container that is built from this repository is located at `https://cloud.docker.com/u/admiralawkbar/repository/docker/admiralawkbar/super-linter`
|
||||
|
||||
|
|
Loading…
Reference in a new issue