Skip to content

Commit

Permalink
chore(docs): updating readme to show new options in config json
Browse files Browse the repository at this point in the history
  • Loading branch information
allanbowe committed Jan 29, 2025
1 parent 05121b7 commit fe88d4e
Showing 1 changed file with 17 additions and 14 deletions.
31 changes: 17 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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

Expand Down

0 comments on commit fe88d4e

Please sign in to comment.