mirror of
https://github.com/sasjs/lint.git
synced 2025-12-10 09:34:34 +00:00
chore(docs): updating readme to show new options in config json
This commit is contained in:
31
README.md
31
README.md
@@ -25,6 +25,8 @@ Configuration is via a `.sasjslint` file with the following structure (these are
|
||||
"hasDoxygenHeader": true,
|
||||
"hasMacroNameInMend": true,
|
||||
"hasMacroParentheses": true,
|
||||
"hasRequiredMacroOptions": false,
|
||||
"requiredMacroOptions": ["SECURE", "SRC"],
|
||||
"ignoreList": ["sasjsbuild/", "sasjsresults/"],
|
||||
"indentationMultiple": 2,
|
||||
"lineEndings": "off",
|
||||
@@ -116,6 +118,21 @@ As per the example [here](https://github.com/sasjs/lint/issues/20), macros defin
|
||||
- Default: true
|
||||
- Severity: WARNING
|
||||
|
||||
### hasRequiredMacroOptions
|
||||
|
||||
This will require macros to have the options listed as "requiredMacroOptions." This is helpful if you want to ensure all macros are SECURE.
|
||||
|
||||
- Default: false
|
||||
- severity: WARNING
|
||||
|
||||
Example
|
||||
```json
|
||||
{
|
||||
"hasRequiredMacroOptions": true,
|
||||
"requiredMacroOptions": ["SECURE", "SRC"]
|
||||
}
|
||||
```
|
||||
|
||||
### ignoreList
|
||||
|
||||
There may be specific files (or folders) that are not good candidates for linting. Simply list them in this array and they will be ignored. In addition, any files in the project `.gitignore` file will also be ignored.
|
||||
@@ -254,20 +271,6 @@ This will highlight lines with trailing spaces. Trailing spaces serve no useful
|
||||
- Default: true
|
||||
- severity: WARNING
|
||||
|
||||
### hasRequiredMacroOptions
|
||||
|
||||
This will require macros to have the options listed as "requiredMacroOptions." This is helpful if you want to ensure all macros are SECURE.
|
||||
|
||||
- Default: false
|
||||
- severity: WARNING
|
||||
|
||||
Example
|
||||
```json
|
||||
{
|
||||
"hasRequiredMacroOptions": true,
|
||||
"requiredMacroOptions": ["SECURE", "SRC"]
|
||||
}
|
||||
```
|
||||
|
||||
## severityLevel
|
||||
|
||||
|
||||
Reference in New Issue
Block a user