actions/superlint
1
0
Fork 0
mirror of https://github.com/super-linter/super-linter.git synced 2024-11-13 20:39:33 -05:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #93 from github/CleanupRunLocal

Browse source 
even better
This commit is contained in:
Lukas Gravley 2020-05-14 09:36:03 -05:00 committed by GitHub
commit d439f6aea7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 77 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

102
docs/run-linter-locally.md
View file

@ -21,83 +21,31 @@ Once the container has been downloaded to your local environment, you can then b
- To run against a single file you can use: `docker run -e RUN_LOCAL=true -v /path/to/local/codebase/file:/tmp/lint/file admiralawkbar/super-linter` - To run against a single file you can use: `docker run -e RUN_LOCAL=true -v /path/to/local/codebase/file:/tmp/lint/file admiralawkbar/super-linter`
- **NOTE:** You need to pass the `RUN_LOCAL` flag to bypass some of the GitHub Actions checks, as well as the mapping of your local codebase to `/tmp/lint` so that the linter can pick up the code - **NOTE:** You need to pass the `RUN_LOCAL` flag to bypass some of the GitHub Actions checks, as well as the mapping of your local codebase to `/tmp/lint` so that the linter can pick up the code
- **NOTE:** The flag:`RUN_LOCAL` will set: `VALIDATE_ALL_CODEBASE` to true. This means it will scan **all** the files in the directory you have mapped. If you want to only validate a subset of your codebase, map a folder with only the files you wish to have linted - **NOTE:** The flag:`RUN_LOCAL` will set: `VALIDATE_ALL_CODEBASE` to true. This means it will scan **all** the files in the directory you have mapped. If you want to only validate a subset of your codebase, map a folder with only the files you wish to have linted
- You can add as many **Additional** flags as needed:
- **VALIDATE_YAML** ### Flags for running Locally
- `-e VALIDATE_YAML=<true|false>` You can add as many **Additional** flags as needed:
- Default: `true`
- Flag to enable or disable the linting process of the language | **ENV VAR** | **Command** | **Default Value** | **Notes** |
- **VALIDATE_JSON** | --- | --- | --- | --- |
- `-e VALIDATE_JSON=<true|false>` | **VALIDATE_YAML** | `-e VALIDATE_YAML=<true\|false>` | `true` | Flag to enable or disable the linting process of the language |
- Default: `true` | **VALIDATE_JSON** | `-e VALIDATE_JSON=<true\|false>` | `true` | Flag to enable or disable the linting process of the language |
- Flag to enable or disable the linting process of the language | **VALIDATE_XML** | `-e VALIDATE_XML=<true\|false>` | `true` | Flag to enable or disable the linting process of the language |
- **VALIDATE_XML** | **VALIDATE_MD** | `-e VALIDATE_MD=<true\|false>` | `true` | Flag to enable or disable the linting process of the language |
- `-e VALIDATE_XML=<true|false>` | **VALIDATE_BASH** | `-e VALIDATE_BASH=<true\|false>` | `true` | Flag to enable or disable the linting process of the language |
- Default: `true` | **VALIDATE_PERL** | `-e VALIDATE_PERL=<true\|false>` | `true` | Flag to enable or disable the linting process of the language |
- Flag to enable or disable the linting process of the language | **VALIDATE_PYTHON** | `-e VALIDATE_PYTHON=<true\|false>` | `true` | Flag to enable or disable the linting process of the language |
- **VALIDATE_MD** | **VALIDATE_RUBY** | `-e VALIDATE_RUBY=<true\|false>` | `true` | Flag to enable or disable the linting process of the language |
- `-e VALIDATE_MD=<true|false>` | **VALIDATE_COFFEE** | `-e VALIDATE_COFFEE=<true\|false>` | `true` | Flag to enable or disable the linting process of the language |
- Default: `true` | **VALIDATE_ANSIBLE** | `-e VALIDATE_ANSIBLE=<true\|false>` | `true` | Flag to enable or disable the linting process of the language |
- Flag to enable or disable the linting process of the language | **VALIDATE_JAVASCRIPT_ES** | `-e VALIDATE_JAVASCRIPT_ES=<true\|false>` | `true` | Flag to enable or disable the linting process of the language (Utilizing: eslint) |
- **VALIDATE_BASH** | **VALIDATE_JAVASCRIPT_STANDARD** | `-e VALIDATE_JAVASCRIPT_STANDARD=<true\|false>` | `true` | Flag to enable or disable the linting process of the language (Utilizing: standard) |
- `-e VALIDATE_BASH=<true|false>` | **VALIDATE_TYPESCRIPT_ES** | `-e VALIDATE_TYPESCRIPT_ES=<true\|false>` | `true` | Flag to enable or disable the linting process of the language (Utilizing: eslint) |
- Default: `true` | **VALIDATE_TYPESCRIPT_STANDARD** | `-e VALIDATE_TYPESCRIPT_STANDARD=<true\|false>` | `true` | Flag to enable or disable the linting process of the language (Utilizing: standard) |
- Flag to enable or disable the linting process of the language | **VALIDATE_DOCKER** | `-e VALIDATE_DOCKER=<true\|false>` | `true` | Flag to enable or disable the linting process of the language |
- **VALIDATE_PERL** | **VALIDATE_GO** | `-e VALIDATE_GO=<true\|false>` | `true` | Flag to enable or disable the linting process of the language |
- `-e VALIDATE_PERL=<true|false>` | **VALIDATE_TERRAFORM** | `-e VALIDATE_TERRAFORM=<true\|false>` | `true` | Flag to enable or disable the linting process of the language |
- Default: `true` | **ANSIBLE_DIRECTORY** | `-e ANSIBLE_DIRECTORY=</path/local/to/codebase/with/ansible>` | `/ansible` | Flag to set the root directory for Ansible file location(s) |
- Flag to enable or disable the linting process of the language | **ACTIONS_RUNNER_DEBUG** | `-e ACTIONS_RUNNER_DEBUG=<true\|false>` | `false` | Flag to enable or disable additional debug info |
- **VALIDATE_PYTHON**
- `-e VALIDATE_PYTHON=<true|false>`
- Default: `true`
- Flag to enable or disable the linting process of the language
- **VALIDATE_RUBY**
- `-e VALIDATE_RUBY=<true|false>`
- Default: `true`
- Flag to enable or disable the linting process of the language
- **VALIDATE_COFFEE**
- `-e VALIDATE_COFFEE=<true|false>`
- Default: `true`
- Flag to enable or disable the linting process of the language
- **VALIDATE_ANSIBLE**
- `-e VALIDATE_ANSIBLE=<true|false>`
- Default: `true`
- Flag to enable or disable the linting process of the language
- **VALIDATE_JAVASCRIPT_ES**
- `-e VALIDATE_JAVASCRIPT_ES=<true|false>`
- Default: `true`
- Flag to enable or disable the linting process of the language (Utilizing: eslint)
- **VALIDATE_JAVASCRIPT_STANDARD**
- `-e VALIDATE_JAVASCRIPT_STANDARD=<true|false>`
- Default: `true`
- Flag to enable or disable the linting process of the language (Utilizing: standard)
- **VALIDATE_TYPESCRIPT_ES**
- `-e VALIDATE_TYPESCRIPT_ES=<true|false>`
- Default: `true`
- Flag to enable or disable the linting process of the language (Utilizing: eslint)
- **VALIDATE_TYPESCRIPT_STANDARD**
- `-e VALIDATE_TYPESCRIPT_STANDARD=<true|false>`
- Default: `true`
- Flag to enable or disable the linting process of the language (Utilizing: standard)
- **VALIDATE_DOCKER**
- `-e VALIDATE_DOCKER=<true|false>`
- Default: `true`
- Flag to enable or disable the linting process of the language
- **VALIDATE_GO**
- `-e VALIDATE_GO=<true|false>`
- Default: `true`
- Flag to enable or disable the linting process of the language
- **VALIDATE_TERRAFORM**
- `-e VALIDATE_TERRAFORM=<true|false>`
- Default: `true`
- Flag to enable or disable the linting process of the language
- **ANSIBLE_DIRECTORY**
- `-e ANSIBLE_DIRECTORY=</path/local/to/codebase/with/ansible>`
- Default: `/ansible`
- Flag to set the root directory for Ansible file location(s)
- **ACTIONS_RUNNER_DEBUG**
- `-e ACTIONS_RUNNER_DEBUG=<true|false>`
- Default: `false`
- Flag to enable or disable additional debug info
## Troubleshooting ## Troubleshooting