mirror of
https://github.com/sasjs/lint.git
synced 2026-01-17 01:00:06 +00:00
fix: README
This commit is contained in:
23
README.md
23
README.md
@@ -33,12 +33,33 @@ Configuration is via a `.sasjslint` file with the following structure (these are
|
|||||||
"noNestedMacros": true,
|
"noNestedMacros": true,
|
||||||
"noSpacesInFileNames": true,
|
"noSpacesInFileNames": true,
|
||||||
"noTabIndentation": true,
|
"noTabIndentation": true,
|
||||||
"noTrailingSpaces": true
|
"noTrailingSpaces": true,
|
||||||
|
"defaultHeader": "/**{lineEnding} @file{lineEnding} @brief <Your brief here>{lineEnding} <h4> SAS Macros </h4>{lineEnding}**/"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### SAS Lint Settings
|
### SAS Lint Settings
|
||||||
|
|
||||||
|
#### defaultHeader
|
||||||
|
|
||||||
|
This sets the default program header - applies when a SAS program does NOT begin with `/**`. The default header is as follows:
|
||||||
|
|
||||||
|
```sas
|
||||||
|
/**
|
||||||
|
@file
|
||||||
|
@brief <Your brief here>
|
||||||
|
<h4> SAS Macros </h4>
|
||||||
|
**/
|
||||||
|
```
|
||||||
|
|
||||||
|
The default header is automatically applied when running `sasjs lint fix` in the SASjs CLI, or by hitting "save" when using the SASjs VS Code extension. If creating a new value, use `{lineEnding}` instead of `\n`, eg as follows:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"defaultHeader": "/**{lineEnding} @file{lineEnding} @brief Our Company Brief{lineEnding}**/"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
#### noEncodedPasswords
|
#### noEncodedPasswords
|
||||||
|
|
||||||
This will highlight any rows that contain a `{sas00X}` type password, or `{sasenc}`. These passwords (especially 001 and 002) are NOT secure, and should NEVER be pushed to source control or saved to the filesystem without special permissions applied.
|
This will highlight any rows that contain a `{sas00X}` type password, or `{sasenc}`. These passwords (especially 001 and 002) are NOT secure, and should NEVER be pushed to source control or saved to the filesystem without special permissions applied.
|
||||||
|
|||||||
Reference in New Issue
Block a user