actions/superlint
1
0
Fork 0
mirror of https://github.com/super-linter/super-linter.git synced 2024-11-21 16:21:00 -05:00
Code Issues Projects Releases Packages Wiki Activity

docs: improve ignore/exclude examples (#6088)

Browse source 
* Provide more robust regexps for ignore/exclude examples
* Drop stray backticks from `LINTER_RULES_PATH` example
This commit is contained in:
George L. Yermulnik 2024-09-21 18:23:35 +03:00 committed by GitHub
parent 5d6e3fcecc
commit c9116aac88
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 15 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -601,7 +601,7 @@ For example, you can configure super-linter to load configuration files from the
```yaml ```yaml
env: env:
LINTER_RULES_PATH: `config/lint` LINTER_RULES_PATH: config/lint
``` ```
Some of the linters that super-linter provides can be configured to disable Some of the linters that super-linter provides can be configured to disable
@ -617,12 +617,20 @@ two environment variables: `FILTER_REGEX_INCLUDE` and `FILTER_REGEX_EXCLUDE`.
For example: For example:
- Lint only the `src` folder: `FILTER_REGEX_INCLUDE: .*src/.*` - Lint the `src` folder in the root of the repository:
- Do not lint files inside test folder: `FILTER_REGEX_EXCLUDE: .*test/.*` `FILTER_REGEX_INCLUDE: ^src/`
- Do not lint JavaScript files inside test folder: - Lint all `src` folders in the repository: `FILTER_REGEX_INCLUDE: (^|/)src/`
`FILTER_REGEX_EXCLUDE: .*test/.*.js` - Do not lint files inside `test` folder in the root of the repository:
`FILTER_REGEX_EXCLUDE: ^test/`
- Do not lint files inside all `test` folders in the repository:
`FILTER_REGEX_EXCLUDE: (^|/)test/`
- Do not lint JavaScript files inside `test` folder in the root of the
repository: `FILTER_REGEX_EXCLUDE: ^test/[^/]+\.js$`
- Do not lint JavaScript files inside `test` folder in the root of the
repository (recursively): `FILTER_REGEX_EXCLUDE: ^test/.+\.js$`
- Do not lint files named `gradlew` and JavaScript files inside a specific - Do not lint files named `gradlew` and JavaScript files inside a specific
directory: `.*/gradlew|.*/specific/directory/*.js` directory:
`FILTER_REGEX_EXCLUDE: ((^|/)gradlew|^specific/directory/[^/]+\.js)$`
<!-- This `README.md` has both markers in the text, so it is considered not generated. --> <!-- This `README.md` has both markers in the text, so it is considered not generated. -->