From 4c9be15608d499fcb16da23118d13ba492b8580d Mon Sep 17 00:00:00 2001 From: Lucas Gravley <29484535+admiralAwkbar@users.noreply.github.com> Date: Thu, 14 May 2020 09:24:23 -0500 Subject: [PATCH] even better --- docs/run-linter-locally.md | 102 +++++++++---------------------------- 1 file changed, 25 insertions(+), 77 deletions(-) diff --git a/docs/run-linter-locally.md b/docs/run-linter-locally.md index 4bfdee18..a1803746 100644 --- a/docs/run-linter-locally.md +++ b/docs/run-linter-locally.md @@ -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` - **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 -- You can add as many **Additional** flags as needed: - - **VALIDATE_YAML** - - `-e VALIDATE_YAML=` - - Default: `true` - - Flag to enable or disable the linting process of the language - - **VALIDATE_JSON** - - `-e VALIDATE_JSON=` - - Default: `true` - - Flag to enable or disable the linting process of the language - - **VALIDATE_XML** - - `-e VALIDATE_XML=` - - Default: `true` - - Flag to enable or disable the linting process of the language - - **VALIDATE_MD** - - `-e VALIDATE_MD=` - - Default: `true` - - Flag to enable or disable the linting process of the language - - **VALIDATE_BASH** - - `-e VALIDATE_BASH=` - - Default: `true` - - Flag to enable or disable the linting process of the language - - **VALIDATE_PERL** - - `-e VALIDATE_PERL=` - - Default: `true` - - Flag to enable or disable the linting process of the language - - **VALIDATE_PYTHON** - - `-e VALIDATE_PYTHON=` - - Default: `true` - - Flag to enable or disable the linting process of the language - - **VALIDATE_RUBY** - - `-e VALIDATE_RUBY=` - - Default: `true` - - Flag to enable or disable the linting process of the language - - **VALIDATE_COFFEE** - - `-e VALIDATE_COFFEE=` - - Default: `true` - - Flag to enable or disable the linting process of the language - - **VALIDATE_ANSIBLE** - - `-e VALIDATE_ANSIBLE=` - - Default: `true` - - Flag to enable or disable the linting process of the language - - **VALIDATE_JAVASCRIPT_ES** - - `-e VALIDATE_JAVASCRIPT_ES=` - - Default: `true` - - Flag to enable or disable the linting process of the language (Utilizing: eslint) - - **VALIDATE_JAVASCRIPT_STANDARD** - - `-e VALIDATE_JAVASCRIPT_STANDARD=` - - Default: `true` - - Flag to enable or disable the linting process of the language (Utilizing: standard) - - **VALIDATE_TYPESCRIPT_ES** - - `-e VALIDATE_TYPESCRIPT_ES=` - - Default: `true` - - Flag to enable or disable the linting process of the language (Utilizing: eslint) - - **VALIDATE_TYPESCRIPT_STANDARD** - - `-e VALIDATE_TYPESCRIPT_STANDARD=` - - Default: `true` - - Flag to enable or disable the linting process of the language (Utilizing: standard) - - **VALIDATE_DOCKER** - - `-e VALIDATE_DOCKER=` - - Default: `true` - - Flag to enable or disable the linting process of the language - - **VALIDATE_GO** - - `-e VALIDATE_GO=` - - Default: `true` - - Flag to enable or disable the linting process of the language - - **VALIDATE_TERRAFORM** - - `-e VALIDATE_TERRAFORM=` - - Default: `true` - - Flag to enable or disable the linting process of the language - - **ANSIBLE_DIRECTORY** - - `-e ANSIBLE_DIRECTORY=` - - Default: `/ansible` - - Flag to set the root directory for Ansible file location(s) - - **ACTIONS_RUNNER_DEBUG** - - `-e ACTIONS_RUNNER_DEBUG=` - - Default: `false` - - Flag to enable or disable additional debug info + +### Flags for running Locally +You can add as many **Additional** flags as needed: + +| **ENV VAR** | **Command** | **Default Value** | **Notes** | +| --- | --- | --- | --- | +| **VALIDATE_YAML** | `-e VALIDATE_YAML=` | `true` | Flag to enable or disable the linting process of the language | +| **VALIDATE_JSON** | `-e VALIDATE_JSON=` | `true` | Flag to enable or disable the linting process of the language | +| **VALIDATE_XML** | `-e VALIDATE_XML=` | `true` | Flag to enable or disable the linting process of the language | +| **VALIDATE_MD** | `-e VALIDATE_MD=` | `true` | Flag to enable or disable the linting process of the language | +| **VALIDATE_BASH** | `-e VALIDATE_BASH=` | `true` | Flag to enable or disable the linting process of the language | +| **VALIDATE_PERL** | `-e VALIDATE_PERL=` | `true` | Flag to enable or disable the linting process of the language | +| **VALIDATE_PYTHON** | `-e VALIDATE_PYTHON=` | `true` | Flag to enable or disable the linting process of the language | +| **VALIDATE_RUBY** | `-e VALIDATE_RUBY=` | `true` | Flag to enable or disable the linting process of the language | +| **VALIDATE_COFFEE** | `-e VALIDATE_COFFEE=` | `true` | Flag to enable or disable the linting process of the language | +| **VALIDATE_ANSIBLE** | `-e VALIDATE_ANSIBLE=` | `true` | Flag to enable or disable the linting process of the language | +| **VALIDATE_JAVASCRIPT_ES** | `-e VALIDATE_JAVASCRIPT_ES=` | `true` | Flag to enable or disable the linting process of the language (Utilizing: eslint) | +| **VALIDATE_JAVASCRIPT_STANDARD** | `-e VALIDATE_JAVASCRIPT_STANDARD=` | `true` | Flag to enable or disable the linting process of the language (Utilizing: standard) | +| **VALIDATE_TYPESCRIPT_ES** | `-e VALIDATE_TYPESCRIPT_ES=` | `true` | Flag to enable or disable the linting process of the language (Utilizing: eslint) | +| **VALIDATE_TYPESCRIPT_STANDARD** | `-e VALIDATE_TYPESCRIPT_STANDARD=` | `true` | Flag to enable or disable the linting process of the language (Utilizing: standard) | +| **VALIDATE_DOCKER** | `-e VALIDATE_DOCKER=` | `true` | Flag to enable or disable the linting process of the language | +| **VALIDATE_GO** | `-e VALIDATE_GO=` | `true` | Flag to enable or disable the linting process of the language | +| **VALIDATE_TERRAFORM** | `-e VALIDATE_TERRAFORM=` | `true` | Flag to enable or disable the linting process of the language | +| **ANSIBLE_DIRECTORY** | `-e ANSIBLE_DIRECTORY=` | `/ansible` | Flag to set the root directory for Ansible file location(s) | +| **ACTIONS_RUNNER_DEBUG** | `-e ACTIONS_RUNNER_DEBUG=` | `false` | Flag to enable or disable additional debug info | ## Troubleshooting