mirror of
https://github.com/sasjs/lint.git
synced 2025-12-11 01:44:36 +00:00
chore(docs): readme updates
This commit is contained in:
19
README.md
19
README.md
@@ -26,6 +26,7 @@ Configuration is via a `.sasjslint` file with the following structure (these are
|
||||
"ignoreList": ["sajsbuild/", "sasjsresults/"],
|
||||
"indentationMultiple": 2,
|
||||
"lowerCaseFileNames": true,
|
||||
"maxHeaderLineLength": 80,
|
||||
"maxLineLength": 80,
|
||||
"noNestedMacros": true,
|
||||
"noGremlins": true,
|
||||
@@ -127,6 +128,20 @@ On *nix systems, it is imperative that autocall macros are in lowercase. When sh
|
||||
- Default: true
|
||||
- Severity: WARNING
|
||||
|
||||
### maxHeaderLineLength
|
||||
|
||||
In a program header it can be necessary to insert items such as URLs or markdown tables, that cannot be split over multiple lines. To avoid the need to increase `maxLineLength` for the entire project, it is possible to raise the line length limit for the header section only.
|
||||
|
||||
The `maxHeaderLineLength` setting is always the _higher_ of `maxHeaderLineLength` and `maxLineLength` (if you set a lower number, it is ignored).
|
||||
|
||||
- Default: 80
|
||||
- Severity: WARNING
|
||||
|
||||
See also:
|
||||
|
||||
* [hasDoxygenHeader](#hasDoxygenHeader)
|
||||
* [maxlinelength](#maxlinelength)
|
||||
|
||||
### maxLineLength
|
||||
|
||||
Code becomes far more readable when line lengths are short. The most compelling reason for short line lengths is to avoid the need to scroll when performing a side-by-side 'compare' between two files (eg as part of a GIT feature branch review). A longer discussion on optimal code line length can be found [here](https://stackoverflow.com/questions/578059/studies-on-optimal-code-width)
|
||||
@@ -138,6 +153,10 @@ We strongly recommend a line length limit, and set the bar at 80. To turn this f
|
||||
- Default: 80
|
||||
- Severity: WARNING
|
||||
|
||||
See also:
|
||||
|
||||
* [maxHeaderLineLength](#maxHeaderLineLength)
|
||||
|
||||
### noGremlins
|
||||
|
||||
Capture zero-width whitespace and other non-standard characters. The logic is borrowed from the [VSCode Gremlins Extension](https://github.com/nhoizey/vscode-gremlins) - if you are looking for more advanced gremlin zapping capabilities, we highly recommend to use their extension instead.
|
||||
|
||||
4181
package-lock.json
generated
4181
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user