From 4e341ecc0417a83df94695567164305b69a5b73c Mon Sep 17 00:00:00 2001 From: John Wiebalk Date: Thu, 9 Jan 2020 14:24:55 -0500 Subject: [PATCH] add command for single file --- .github/run-linter-locally.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/run-linter-locally.md b/.github/run-linter-locally.md index 99ec713e..073b8e88 100644 --- a/.github/run-linter-locally.md +++ b/.github/run-linter-locally.md @@ -18,6 +18,7 @@ Once the container has been downloaded to your local environment, you can then b ## Run the container Locally - You can run the container locally with the following **Base** flags to run your code: - `docker run -e RUN_LOCAL=true -v /path/to/local/codebase:/tmp/lint 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:** 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: