From 17d09ffc02cc6bea2fafd70f1aa4eeb2f6815eca Mon Sep 17 00:00:00 2001 From: NicolasVuillamy Date: Sat, 5 Sep 2020 12:54:56 +0200 Subject: [PATCH] Add README index --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9823cf84..8a66708e 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,7 @@ It is a simple combination of various linters, written in `bash`, to help valida - [Environment variables](#environment-variables) - [Template rules files](#template-rules-files) - [Disabling rules](#disabling-rules) + - [Filter linted files](#filter-linted-files) - [Docker Hub](#docker-hub) - [Run Super-Linter outside GitHub Actions](#run-super-linter-outside-github-actions) - [Local (troubleshooting/debugging/enhancements)](#local-troubleshootingdebuggingenhancements) @@ -181,8 +182,8 @@ But if you wish to select or exclude specific linters, we give you full control | **DEFAULT_WORKSPACE** | `/tmp/lint` | The location containing files to lint if you are running locally. | | **DISABLE_ERRORS** | `false` | Flag to have the linter complete with exit code 0 even if errors were detected. | | **DOCKERFILE_HADOLINT_FILE_NAME** | `.hadolint.yml` | Filename for [hadolint configuration](https://github.com/hadolint/hadolint) (ex: `.hadolintlintrc.yaml`) | -| **FILTER_REGEX_EXCLUDE** | `none` | Regular expression defining which files will be excluded from linting (ex: `.*src/test.*`) | -| **FILTER_REGEX_INCLUDE** | `all` | Regular expression defining which files will be processed by linters (ex: `.*src/.*`) | +| **FILTER_REGEX_EXCLUDE** | `none` | Regular expression defining which files will be excluded from linting (ex: `.*src/test.*`) | +| **FILTER_REGEX_INCLUDE** | `all` | Regular expression defining which files will be processed by linters (ex: `.*src/.*`) | | **JAVASCRIPT_ES_CONFIG_FILE** | `.eslintrc.yml` | Filename for [eslint configuration](https://eslint.org/docs/user-guide/configuring#configuration-file-formats) (ex: `.eslintrc.yml`, `.eslintrc.json`) | | **LINTER_RULES_PATH** | `.github/linters` | Directory for all linter configuration rules. | | **LOG_FILE** | `super-linter.log` | The file name for outputting logs. All output is sent to the log file regardless of `LOG_LEVEL`. |