mirror of
https://github.com/sasjs/lint.git
synced 2026-01-19 10:10:05 +00:00
chore: add documentation for lineEndings rule
This commit is contained in:
38
README.md
38
README.md
@@ -122,6 +122,13 @@ This will check each line to ensure that the count of leading spaces can be divi
|
|||||||
- Default: 2
|
- Default: 2
|
||||||
- Severity: WARNING
|
- 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
|
### 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.
|
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:
|
This feature will work for the following statements:
|
||||||
|
|
||||||
* cards
|
- cards
|
||||||
* cards4
|
- cards4
|
||||||
* datalines
|
- datalines
|
||||||
* datalines4
|
- datalines4
|
||||||
* parmcards
|
- parmcards
|
||||||
* parmcards4
|
- parmcards4
|
||||||
|
|
||||||
The `maxDataLineLength` setting is always the _higher_ of `maxDataLineLength` and `maxLineLength` (if you set a lower number, it is ignored).
|
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:
|
See also:
|
||||||
|
|
||||||
* [hasDoxygenHeader](#hasdoxygenheader)
|
- [hasDoxygenHeader](#hasdoxygenheader)
|
||||||
* [maxHeaderLineLength](#maxheaderlinelength)
|
- [maxHeaderLineLength](#maxheaderlinelength)
|
||||||
* [maxLineLength](#maxlinelength)
|
- [maxLineLength](#maxlinelength)
|
||||||
|
|
||||||
### maxHeaderLineLength
|
### maxHeaderLineLength
|
||||||
|
|
||||||
@@ -164,9 +171,9 @@ The `maxHeaderLineLength` setting is always the _higher_ of `maxHeaderLineLength
|
|||||||
|
|
||||||
See also:
|
See also:
|
||||||
|
|
||||||
* [hasDoxygenHeader](#hasdoxygenheader)
|
- [hasDoxygenHeader](#hasdoxygenheader)
|
||||||
* [maxDataLineLength](#maxdatalinelength)
|
- [maxDataLineLength](#maxdatalinelength)
|
||||||
* [maxLineLength](#maxlinelength)
|
- [maxLineLength](#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:
|
See also:
|
||||||
|
|
||||||
* [maxDataLineLength](#maxdatalinelength)
|
- [maxDataLineLength](#maxdatalinelength)
|
||||||
* [maxHeaderLineLength](#maxheaderlinelength)
|
- [maxHeaderLineLength](#maxheaderlinelength)
|
||||||
|
|
||||||
### noGremlins
|
### noGremlins
|
||||||
|
|
||||||
@@ -249,9 +256,6 @@ This setting allows the default severity to be adjusted. This is helpful when ru
|
|||||||
|
|
||||||
## Upcoming Linting Rules:
|
## 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
|
# SAS Formatter
|
||||||
|
|
||||||
A formatter will automatically apply rules when you hit SAVE, which can save a LOT of time.
|
A formatter will automatically apply rules when you hit SAVE, which can save a LOT of time.
|
||||||
|
|||||||
Reference in New Issue
Block a user