sasjs/lint
1
0
Fork 0
mirror of https://github.com/sasjs/lint.git synced 2026-01-17 17:20:05 +00:00
Code Issues Projects Releases Wiki Activity

chore: add documentation for lineEndings rule

Browse Source
This commit is contained in:
Sabir Hassan
2023-02-15 21:34:25 +05:00
parent ad59159b62
commit 386d0f5ff3
1 changed files with 27 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
README.md
View File

@@ -50,14 +50,14 @@ For more details, and the default state, see the description of each rule below.
### allowedGremlins ### allowedGremlins
An array of hex codes that represents allowed gremlins (invisible / undesirable characters). To allow all gremlins, you can also set the `noGremlins` rule to `false`. An array of hex codes that represents allowed gremlins (invisible / undesirable characters). To allow all gremlins, you can also set the `noGremlins` rule to `false`.
Example: Example:
```json ```json
{ {
"noGremlins": true, "noGremlins": true,
"allowedGremlins": ["0x0080", "0x3000"] "allowedGremlins": ["0x0080", "0x3000"]
} }
``` ```
@@ -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.
@@ -131,16 +138,16 @@ On *nix systems, it is imperative that autocall macros are in lowercase. When sh
### maxDataLineLength ### maxDataLineLength
Datalines can be very wide, so to avoid the need to increase `maxLineLength` for the entire project, it is possible to raise the line length limit for the data records only. On a related note, as a developer, you should also be aware that code submitted in batch may have a default line length limit which is lower than you expect. See this [usage note](https://support.sas.com/kb/15/883.html) (and thanks to [sasutils for reminding us](https://github.com/sasjs/lint/issues/47#issuecomment-1064340104)). Datalines can be very wide, so to avoid the need to increase `maxLineLength` for the entire project, it is possible to raise the line length limit for the data records only. On a related note, as a developer, you should also be aware that code submitted in batch may have a default line length limit which is lower than you expect. See this [usage note](https://support.sas.com/kb/15/883.html) (and thanks to [sasutils for reminding us](https://github.com/sasjs/lint/issues/47#issuecomment-1064340104)).
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,13 +156,13 @@ 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
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. 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). The `maxHeaderLineLength` setting is always the _higher_ of `maxHeaderLineLength` and `maxLineLength` (if you set a lower number, it is ignored).
@@ -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,12 +188,12 @@ 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
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. 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.
The list of characters can be found in this file: [https://github.com/sasjs/lint/blob/main/src/utils/gremlinCharacters.ts](https://github.com/sasjs/lint/blob/main/src/utils/gremlinCharacters.ts) The list of characters can be found in this file: [https://github.com/sasjs/lint/blob/main/src/utils/gremlinCharacters.ts](https://github.com/sasjs/lint/blob/main/src/utils/gremlinCharacters.ts)
@@ -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.