From c1b2ccce03f7d4c7e74fa9c49d7c4982e4eae167 Mon Sep 17 00:00:00 2001 From: Theo Beers <32523293+theodore-s-beers@users.noreply.github.com> Date: Thu, 17 Sep 2020 13:31:50 +0200 Subject: [PATCH] Use YAML syntax in FILTER_REGEX examples I think it probably makes more sense for the examples in this README to follow YAML syntax, assuming that people will be running super-linter as a GitHub Action. There's a separate doc covering the process for running the linter locally, in which case, of course, environment variables would be set with an equals sign. It's not a big deal, but I thought I would make the suggestion. --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3c68d818..fe73ed65 100644 --- a/README.md +++ b/README.md @@ -294,11 +294,11 @@ If you need to disable certain _rules_ and _functionality_, you can view [Disabl If you need to lint only a folder or exclude some files from linting, you can use optional environment parameters `FILTER_REGEX_INCLUDE` and `FILTER_REGEX_EXCLUDE` -Examples : +Examples: -- Lint only src folder: `FILTER_REGEX_INCLUDE=.*src/.*` -- Do not lint files inside test folder: `FILTER_REGEX_EXCLUDE=.*test/.*` -- Do not lint javascript files inside test folder: `FILTER_REGEX_EXCLUDE=.*test/.*.js` +- Lint only src folder: `FILTER_REGEX_INCLUDE: .*src/.*` +- Do not lint files inside test folder: `FILTER_REGEX_EXCLUDE: .*test/.*` +- Do not lint javascript files inside test folder: `FILTER_REGEX_EXCLUDE: .*test/.*.js` ## Docker Hub