1
0
mirror of https://github.com/sasjs/lint.git synced 2026-01-07 04:30:05 +00:00

chore: add documentation for lineEndings rule

This commit is contained in:
2023-02-15 21:34:25 +05:00
parent ad59159b62
commit 386d0f5ff3

View File

@@ -122,6 +122,13 @@ This will check each line to ensure that the count of leading spaces can be divi
- Default: 2
- Severity: WARNING
### lineEndings
This setting ensures the line endings in a file conform to the configured type. Possible values are `lf` and `crlf`.
- Default: lf
- Severity: WARNING
### lowerCaseFileNames
On *nix systems, it is imperative that autocall macros are in lowercase. When sharing code between windows and *nix systems, the difference in case sensitivity can also be a cause of lost developer time. For this reason, we recommend that sas filenames are always lowercase.
@@ -135,12 +142,12 @@ Datalines can be very wide, so to avoid the need to increase `maxLineLength` for
This feature will work for the following statements:
* cards
* cards4
* datalines
* datalines4
* parmcards
* parmcards4
- cards
- cards4
- datalines
- datalines4
- parmcards
- parmcards4
The `maxDataLineLength` setting is always the _higher_ of `maxDataLineLength` and `maxLineLength` (if you set a lower number, it is ignored).
@@ -149,9 +156,9 @@ The `maxDataLineLength` setting is always the _higher_ of `maxDataLineLength` an
See also:
* [hasDoxygenHeader](#hasdoxygenheader)
* [maxHeaderLineLength](#maxheaderlinelength)
* [maxLineLength](#maxlinelength)
- [hasDoxygenHeader](#hasdoxygenheader)
- [maxHeaderLineLength](#maxheaderlinelength)
- [maxLineLength](#maxlinelength)
### maxHeaderLineLength
@@ -164,9 +171,9 @@ The `maxHeaderLineLength` setting is always the _higher_ of `maxHeaderLineLength
See also:
* [hasDoxygenHeader](#hasdoxygenheader)
* [maxDataLineLength](#maxdatalinelength)
* [maxLineLength](#maxlinelength)
- [hasDoxygenHeader](#hasdoxygenheader)
- [maxDataLineLength](#maxdatalinelength)
- [maxLineLength](#maxlinelength)
### maxLineLength
@@ -181,8 +188,8 @@ We strongly recommend a line length limit, and set the bar at 80. To turn this f
See also:
* [maxDataLineLength](#maxdatalinelength)
* [maxHeaderLineLength](#maxheaderlinelength)
- [maxDataLineLength](#maxdatalinelength)
- [maxHeaderLineLength](#maxheaderlinelength)
### noGremlins
@@ -249,9 +256,6 @@ This setting allows the default severity to be adjusted. This is helpful when ru
## Upcoming Linting Rules:
- `noGremlins` -> identifies all invisible characters, other than spaces / tabs / line endings. If you really need that bell character, use a hex literal!
- `lineEndings` -> set a standard line ending, such as LF or CRLF
# SAS Formatter
A formatter will automatically apply rules when you hit SAVE, which can save a LOT of time.