actions/superlint
1
0
Fork 0
mirror of https://github.com/super-linter/super-linter.git synced 2024-09-17 18:07:34 -04:00
Code Issues Projects Releases Packages Wiki Activity

Use YAML syntax in FILTER_REGEX examples

Browse source 
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.
This commit is contained in:
Theo Beers 2020-09-17 13:31:50 +02:00 committed by GitHub
parent 58d3d191b8
commit c1b2ccce03
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -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