mirror of
https://github.com/sasjs/lint.git
synced 2025-12-10 17:34:36 +00:00
Compare commits
16 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
8be59ac591 | ||
|
|
c6a70a1d1a | ||
| 75b103003c | |||
| 0cff87fe12 | |||
|
|
8031468926 | ||
|
|
1e25eab783 | ||
|
|
9623828fc8 | ||
| debeff7929 | |||
| c210699954 | |||
|
|
cee30d0030 | ||
|
|
66bcfb2962 | ||
| a3bade0a5a | |||
|
|
1d821db934 | ||
|
|
f3858d33fc | ||
|
|
0d9e17f072 | ||
|
|
421513850c |
8
.gitpod.yml
Normal file
8
.gitpod.yml
Normal file
@@ -0,0 +1,8 @@
|
||||
# This configuration file was automatically generated by Gitpod.
|
||||
# Please adjust to your needs (see https://www.gitpod.io/docs/config-gitpod-file)
|
||||
# and commit this file to your remote git repository to share the goodness with others.
|
||||
|
||||
tasks:
|
||||
- init: npm install && npm run build
|
||||
|
||||
|
||||
80
README.md
80
README.md
@@ -23,21 +23,55 @@ Configuration is via a `.sasjslint` file with the following structure (these are
|
||||
"hasDoxygenHeader": true,
|
||||
"hasMacroNameInMend": true,
|
||||
"hasMacroParentheses": true,
|
||||
"ignoreList": [
|
||||
"sajsbuild/",
|
||||
"sasjsresults/"
|
||||
],
|
||||
"indentationMultiple": 2,
|
||||
"lowerCaseFileNames": true,
|
||||
"maxLineLength": 80,
|
||||
"noNestedMacros": true,
|
||||
"noSpacesInFileNames": true,
|
||||
"noTabIndentation": true,
|
||||
"noTrailingSpaces": true
|
||||
"noTrailingSpaces": true,
|
||||
"defaultHeader": "/**{lineEnding} @file{lineEnding} @brief <Your brief here>{lineEnding} <h4> SAS Macros </h4>{lineEnding}**/"
|
||||
}
|
||||
```
|
||||
|
||||
### SAS Lint Settings
|
||||
|
||||
Each setting can have three states:
|
||||
|
||||
* OFF - usually by setting the value to `false` or 0. In this case, the rule won't be executed.
|
||||
* WARN - a warning is written to the log, but the return code will be 0
|
||||
* ERROR - an error is written to the log, and the return code is 1
|
||||
|
||||
For more details, and the default state, see the description of each rule below. It is also possible to change whether a rule returns ERROR or WARN using the `severityLevels` object.
|
||||
|
||||
#### defaultHeader
|
||||
|
||||
This isn't actually a rule - but rather a formatting setting, which applies to SAS program that do NOT begin with `/**`. It can be triggered by running `sasjs lint fix` in the SASjs CLI, or by hitting "save" when using the SASjs VS Code extension (with "formatOnSave" in place)
|
||||
|
||||
The default header is as follows:
|
||||
|
||||
```sas
|
||||
/**
|
||||
@file
|
||||
@brief <Your brief here>
|
||||
<h4> SAS Macros </h4>
|
||||
**/
|
||||
```
|
||||
If creating a new value, use `{lineEnding}` instead of `\n`, eg as follows:
|
||||
|
||||
```json
|
||||
{
|
||||
"defaultHeader": "/**{lineEnding} @file{lineEnding} @brief Our Company Brief{lineEnding}**/"
|
||||
}
|
||||
```
|
||||
|
||||
#### 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 rule 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.
|
||||
|
||||
* Default: true
|
||||
* Severity: ERROR
|
||||
@@ -60,6 +94,9 @@ As per the example [here](https://github.com/sasjs/lint/issues/20), macros defin
|
||||
* Default: true
|
||||
* Severity: WARNING
|
||||
|
||||
#### ignoreList
|
||||
There may be specific files (or folders) that are not good candidates for linting. Simply list them in this array and they will be ignored. In addition, any files in the project `.gitignore` file will also be ignored.
|
||||
|
||||
#### indentationMultiple
|
||||
This will check each line to ensure that the count of leading spaces can be divided cleanly by this multiple.
|
||||
|
||||
@@ -75,7 +112,7 @@ On *nix systems, it is imperative that autocall macros are in lowercase. When s
|
||||
#### 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)
|
||||
|
||||
In batch mode, long SAS code lines may also be truncated, causing hard-to-detect errors.
|
||||
In batch mode, long SAS code lines may also be truncated, causing hard-to-detect errors.
|
||||
|
||||
We strongly recommend a line length limit, and set the bar at 80. To turn this feature off, set the value to 0.
|
||||
|
||||
@@ -83,7 +120,7 @@ We strongly recommend a line length limit, and set the bar at 80. To turn this
|
||||
* Severity: WARNING
|
||||
|
||||
#### noNestedMacros
|
||||
Where macros are defined inside other macros, they are recompiled every time the outer macro is invoked. Hence, it is widely considered inefficient, and bad practice, to nest macro definitions.
|
||||
Where macros are defined inside other macros, they are recompiled every time the outer macro is invoked. Hence, it is widely considered inefficient, and bad practice, to nest macro definitions.
|
||||
|
||||
* Default: true
|
||||
* Severity: WARNING
|
||||
@@ -111,9 +148,29 @@ This will highlight lines with trailing spaces. Trailing spaces serve no useful
|
||||
* Default: true
|
||||
* severity: WARNING
|
||||
|
||||
### severityLevel
|
||||
|
||||
This setting allows the default severity to be adjusted. This is helpful when running the lint in a pipeline or git hook. Simply list the rules you would like to adjust along with the desired setting ("warn" or "error"), eg as follows:
|
||||
|
||||
```json
|
||||
{
|
||||
"noTrailingSpaces": true,
|
||||
"hasDoxygenHeader": true,
|
||||
"maxLineLength": 100,
|
||||
"severityLevel": {
|
||||
"hasDoxygenHeader": "warn",
|
||||
"maxLineLength": "error",
|
||||
"noTrailingSpaces": "error"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
* "warn" - show warning in the log (doesn’t affect exit code)
|
||||
* "error" - show error in the log (exit code is 1 when triggered)
|
||||
|
||||
### Upcoming Linting Rules:
|
||||
|
||||
* `noTabs` -> does what it says on the tin
|
||||
* `noTabs` -> does what it says on the tin
|
||||
* `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
|
||||
|
||||
@@ -123,13 +180,13 @@ A formatter will automatically apply rules when you hit SAVE, which can save a L
|
||||
|
||||
We've already implemented the following rules:
|
||||
|
||||
* Add the macro name to the %mend statement
|
||||
* Add a doxygen header template if none exists
|
||||
* Add the macro name to the %mend statement
|
||||
* Add a doxygen header template if none exists
|
||||
* Remove trailing spaces
|
||||
|
||||
We're looking to implement the following rules:
|
||||
|
||||
* Change tabs to spaces
|
||||
* Change tabs to spaces
|
||||
* zap gremlins
|
||||
* fix line endings
|
||||
|
||||
@@ -141,13 +198,6 @@ SASjs is an open source framework! Contributions are welcomed. If you would li
|
||||
|
||||
Contact [Allan Bowe](https://www.linkedin.com/in/allanbowe/) for further details.
|
||||
|
||||
## SAS 9 Health check
|
||||
|
||||
The SASjs Linter (and formatter) is a great way to de-risk and accelerate the delivery of SAS code into production environments. However, code is just one part of a SAS estate. If you are running SAS 9, you may be interested to know what 'gremlins' are lurking in your SAS 9 system. Maybe you are preparing for a migration. Maybe you are preparing to hand over the control of your environment. Either way, an assessment of your existing system would put minds at rest and pro-actively identify trouble spots.
|
||||
|
||||
The SAS 9 Health Check is a 'plug & play' product, that uses the [SAS 9 REST API](https://sas9api.io) to run hundreds of metadata and system checks to identify common problems. The checks are non-invasive, and becuase it is a client app, there is NOTHING TO INSTALL on your SAS server. We offer this assessment for a low fixed fee, and if you engage our (competitively priced) services to address the issues we highlight, then the assessment is free.
|
||||
|
||||
Contact [Allan Bowe](https://www.linkedin.com/in/allanbowe/) for further details.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -7,6 +7,7 @@
|
||||
"default": {
|
||||
"noEncodedPasswords": true,
|
||||
"hasDoxygenHeader": true,
|
||||
"defaultHeader": "/**{lineEnding} @file{lineEnding} @brief <Your brief here>{lineEnding} <h4> SAS Macros </h4>{lineEnding}**/",
|
||||
"hasMacroNameInMend": false,
|
||||
"hasMacroParentheses": true,
|
||||
"indentationMultiple": 2,
|
||||
@@ -17,7 +18,8 @@
|
||||
"noTabIndentation": true,
|
||||
"noTrailingSpaces": true,
|
||||
"lineEndings": "lf",
|
||||
"strictMacroDefinition": true
|
||||
"strictMacroDefinition": true,
|
||||
"ignoreList": ["sajsbuild", "sasjsresults"]
|
||||
},
|
||||
"examples": [
|
||||
{
|
||||
@@ -33,7 +35,8 @@
|
||||
"noNestedMacros": true,
|
||||
"hasMacroParentheses": true,
|
||||
"lineEndings": "crlf",
|
||||
"strictMacroDefinition": true
|
||||
"strictMacroDefinition": true,
|
||||
"ignoreList": ["sajsbuild", "sasjsresults"]
|
||||
}
|
||||
],
|
||||
"properties": {
|
||||
@@ -53,6 +56,14 @@
|
||||
"default": true,
|
||||
"examples": [true, false]
|
||||
},
|
||||
"defaultHeader": {
|
||||
"$id": "#/properties/defaultHeader",
|
||||
"type": "string",
|
||||
"title": "defaultHeader",
|
||||
"description": "This sets the default program header - applies when a SAS program does NOT begin with `/**`.",
|
||||
"default": "/**{lineEnding} @file{lineEnding} @brief <Your brief here>{lineEnding} <h4> SAS Macros </h4>{lineEnding}**/",
|
||||
"examples": []
|
||||
},
|
||||
"hasMacroNameInMend": {
|
||||
"$id": "#/properties/hasMacroNameInMend",
|
||||
"type": "boolean",
|
||||
@@ -143,11 +154,120 @@
|
||||
},
|
||||
"ignoreList": {
|
||||
"$id": "#/properties/ignoreList",
|
||||
"type": "object",
|
||||
"type": "array",
|
||||
"title": "ignoreList",
|
||||
"description": "An array of paths or path patterns to ignore matching resources from linting. Files or folders matching patterns in .gitignore will always be ignored.",
|
||||
"description": "An array of paths or path patterns to ignore when linting. Any files or matching patterns in the .gitignore file will also be ignored.",
|
||||
"default": ["sasjsbuild/", "sasjsresults/"],
|
||||
"examples": ["sasjs/services", "appinit.sas"]
|
||||
"examples": ["sasjs/tests", "tmp/scratch.sas"]
|
||||
},
|
||||
"severityLevel": {
|
||||
"$id": "#/properties/severityLevel",
|
||||
"type": "object",
|
||||
"title": "severityLevel",
|
||||
"description": "An object which specifies the severity level of each rule.",
|
||||
"default": {},
|
||||
"examples": [{
|
||||
"hasDoxygenHeader": "warn",
|
||||
"maxLineLength": "warn",
|
||||
"noTrailingSpaces": "error"
|
||||
}, {
|
||||
"hasDoxygenHeader": "warn",
|
||||
"maxLineLength": "error",
|
||||
"noTrailingSpaces": "error"
|
||||
}],
|
||||
"properties": {
|
||||
"noEncodedPasswords": {
|
||||
"$id": "#/properties/severityLevel/noEncodedPasswords",
|
||||
"title": "noEncodedPasswords",
|
||||
"type": "string",
|
||||
"enum": ["error", "warn"],
|
||||
"default": "error"
|
||||
},
|
||||
"hasDoxygenHeader": {
|
||||
"$id": "#/properties/severityLevel/hasDoxygenHeader",
|
||||
"title": "hasDoxygenHeader",
|
||||
"type": "string",
|
||||
"enum": ["error", "warn"],
|
||||
"default": "warn" },
|
||||
"hasMacroNameInMend": {
|
||||
"$id": "#/properties/severityLevel/hasMacroNameInMend",
|
||||
"title": "hasMacroNameInMend",
|
||||
"type": "string",
|
||||
"enum": ["error", "warn"],
|
||||
"default": "warn"
|
||||
},
|
||||
"hasMacroParentheses": {
|
||||
"$id": "#/properties/severityLevel/hasMacroParentheses",
|
||||
"title": "hasMacroParentheses",
|
||||
"type": "string",
|
||||
"enum": ["error", "warn"],
|
||||
"default": "warn"
|
||||
},
|
||||
"indentationMultiple": {
|
||||
"$id": "#/properties/severityLevel/indentationMultiple",
|
||||
"title": "indentationMultiple",
|
||||
"type": "string",
|
||||
"enum": ["error", "warn"],
|
||||
"default": "warn"
|
||||
},
|
||||
"lowerCaseFileNames": {
|
||||
"$id": "#/properties/severityLevel/lowerCaseFileNames",
|
||||
"title": "lowerCaseFileNames",
|
||||
"type": "string",
|
||||
"enum": ["error", "warn"],
|
||||
"default": "warn"
|
||||
},
|
||||
"maxLineLength": {
|
||||
"$id": "#/properties/severityLevel/maxLineLength",
|
||||
"title": "maxLineLength",
|
||||
"type": "string",
|
||||
"enum": ["error", "warn"],
|
||||
"default": "warn"
|
||||
},
|
||||
"noNestedMacros": {
|
||||
"$id": "#/properties/severityLevel/noNestedMacros",
|
||||
"title": "noNestedMacros",
|
||||
"type": "string",
|
||||
"enum": ["error", "warn"],
|
||||
"default": "warn"
|
||||
},
|
||||
"noSpacesInFileNames": {
|
||||
"$id": "#/properties/severityLevel/noSpacesInFileNames",
|
||||
"title": "noSpacesInFileNames",
|
||||
"type": "string",
|
||||
"enum": ["error", "warn"],
|
||||
"default": "warn"
|
||||
},
|
||||
"noTabIndentation": {
|
||||
"$id": "#/properties/severityLevel/noTabIndentation",
|
||||
"title": "noTabIndentation",
|
||||
"type": "string",
|
||||
"enum": ["error", "warn"],
|
||||
"default": "warn"
|
||||
},
|
||||
"noTrailingSpaces": {
|
||||
"$id": "#/properties/severityLevel/noTrailingSpaces",
|
||||
"title": "noTrailingSpaces",
|
||||
"type": "string",
|
||||
"enum": ["error", "warn"],
|
||||
"default": "warn"
|
||||
},
|
||||
"lineEndings": {
|
||||
"$id": "#/properties/severityLevel/lineEndings",
|
||||
"title": "lineEndings",
|
||||
"type": "string",
|
||||
"enum": ["error", "warn"],
|
||||
"default": "warn"
|
||||
},
|
||||
"strictMacroDefinition": {
|
||||
"$id": "#/properties/severityLevel/strictMacroDefinition",
|
||||
"title": "strictMacroDefinition",
|
||||
"type": "string",
|
||||
"enum": ["error", "warn"],
|
||||
"default": "warn"
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,7 +1,8 @@
|
||||
import { LintConfig } from '../types'
|
||||
import { getLintConfig } from '../utils'
|
||||
import { processText } from './shared'
|
||||
|
||||
export const formatText = async (text: string) => {
|
||||
const config = await getLintConfig()
|
||||
export const formatText = async (text: string, configuration?: LintConfig) => {
|
||||
const config = configuration || (await getLintConfig())
|
||||
return processText(text, config)
|
||||
}
|
||||
|
||||
@@ -19,7 +19,7 @@ const processContent = (config: LintConfig, content: string): string => {
|
||||
config.fileLintRules
|
||||
.filter((r) => !!r.fix)
|
||||
.forEach((rule) => {
|
||||
processedContent = rule.fix!(processedContent)
|
||||
processedContent = rule.fix!(processedContent, config)
|
||||
})
|
||||
|
||||
return processedContent
|
||||
@@ -30,7 +30,7 @@ export const processLine = (config: LintConfig, line: string): string => {
|
||||
config.lineLintRules
|
||||
.filter((r) => !!r.fix)
|
||||
.forEach((rule) => {
|
||||
processedLine = rule.fix!(line)
|
||||
processedLine = rule.fix!(line, config)
|
||||
})
|
||||
|
||||
return processedLine
|
||||
|
||||
@@ -18,7 +18,7 @@ export const processFile = (
|
||||
): Diagnostic[] => {
|
||||
const diagnostics: Diagnostic[] = []
|
||||
config.pathLintRules.forEach((rule) => {
|
||||
diagnostics.push(...rule.test(filePath))
|
||||
diagnostics.push(...rule.test(filePath, config))
|
||||
})
|
||||
|
||||
return diagnostics
|
||||
@@ -27,7 +27,7 @@ export const processFile = (
|
||||
const processContent = (config: LintConfig, content: string): Diagnostic[] => {
|
||||
const diagnostics: Diagnostic[] = []
|
||||
config.fileLintRules.forEach((rule) => {
|
||||
diagnostics.push(...rule.test(content))
|
||||
diagnostics.push(...rule.test(content, config))
|
||||
})
|
||||
|
||||
return diagnostics
|
||||
|
||||
@@ -3,8 +3,7 @@ import { LineEndings } from '../../types/LineEndings'
|
||||
import { FileLintRule } from '../../types/LintRule'
|
||||
import { LintRuleType } from '../../types/LintRuleType'
|
||||
import { Severity } from '../../types/Severity'
|
||||
|
||||
const DoxygenHeader = `/**{lineEnding} @file{lineEnding} @brief <Your brief here>{lineEnding} <h4> SAS Macros </h4>{lineEnding}**/`
|
||||
import { DefaultLintConfiguration } from '../../utils/getLintConfig'
|
||||
|
||||
const name = 'hasDoxygenHeader'
|
||||
const description =
|
||||
@@ -12,8 +11,11 @@ const description =
|
||||
const message = 'File missing Doxygen header'
|
||||
const messageForSingleAsterisk =
|
||||
'File not following Doxygen header style, use double asterisks'
|
||||
|
||||
const test = (value: string, config?: LintConfig) => {
|
||||
const lineEnding = config?.lineEndings === LineEndings.CRLF ? '\r\n' : '\n'
|
||||
const severity = config?.severityLevel[name] || Severity.Warning
|
||||
|
||||
try {
|
||||
const hasFileHeader = value.trimStart().startsWith('/**')
|
||||
if (hasFileHeader) return []
|
||||
@@ -28,7 +30,7 @@ const test = (value: string, config?: LintConfig) => {
|
||||
.length + 1,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
severity
|
||||
}
|
||||
]
|
||||
|
||||
@@ -38,7 +40,7 @@ const test = (value: string, config?: LintConfig) => {
|
||||
lineNumber: 1,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
severity
|
||||
}
|
||||
]
|
||||
} catch (e) {
|
||||
@@ -48,7 +50,7 @@ const test = (value: string, config?: LintConfig) => {
|
||||
lineNumber: 1,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
severity
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -61,10 +63,11 @@ const fix = (value: string, config?: LintConfig): string => {
|
||||
} else if (result[0].message == messageForSingleAsterisk)
|
||||
return value.replace('/*', '/**')
|
||||
|
||||
config = config || new LintConfig(DefaultLintConfiguration)
|
||||
const lineEndingConfig = config?.lineEndings || LineEndings.LF
|
||||
const lineEnding = lineEndingConfig === LineEndings.LF ? '\n' : '\r\n'
|
||||
|
||||
return `${DoxygenHeader.replace(
|
||||
return `${config?.defaultHeader.replace(
|
||||
/{lineEnding}/g,
|
||||
lineEnding
|
||||
)}${lineEnding}${value}`
|
||||
|
||||
@@ -11,11 +11,14 @@ const name = 'hasMacroNameInMend'
|
||||
const description =
|
||||
'Enforces the presence of the macro name in each %mend statement.'
|
||||
const message = '%mend statement has missing or incorrect macro name'
|
||||
|
||||
const test = (value: string, config?: LintConfig) => {
|
||||
const lineEnding = config?.lineEndings === LineEndings.CRLF ? '\r\n' : '\n'
|
||||
const lines: string[] = value ? value.split(lineEnding) : []
|
||||
const macros = parseMacros(value, config)
|
||||
const severity = config?.severityLevel[name] || Severity.Warning
|
||||
const diagnostics: Diagnostic[] = []
|
||||
|
||||
macros.forEach((macro) => {
|
||||
if (macro.startLineNumbers.length === 0 && macro.endLineNumber !== null) {
|
||||
const endLine = lines[macro.endLineNumber - 1]
|
||||
@@ -25,7 +28,7 @@ const test = (value: string, config?: LintConfig) => {
|
||||
startColumnNumber: getColumnNumber(endLine, '%mend'),
|
||||
endColumnNumber:
|
||||
getColumnNumber(endLine, '%mend') + macro.termination.length,
|
||||
severity: Severity.Warning
|
||||
severity
|
||||
})
|
||||
} else if (
|
||||
macro.endLineNumber === null &&
|
||||
@@ -36,7 +39,7 @@ const test = (value: string, config?: LintConfig) => {
|
||||
lineNumber: macro.startLineNumbers![0],
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
severity
|
||||
})
|
||||
} else if (macro.mismatchedMendMacroName) {
|
||||
const endLine = lines[(macro.endLineNumber as number) - 1]
|
||||
@@ -53,7 +56,7 @@ const test = (value: string, config?: LintConfig) => {
|
||||
getColumnNumber(endLine, macro.mismatchedMendMacroName) +
|
||||
macro.mismatchedMendMacroName.length -
|
||||
1,
|
||||
severity: Severity.Warning
|
||||
severity
|
||||
})
|
||||
} else if (!macro.hasMacroNameInMend) {
|
||||
const endLine = lines[(macro.endLineNumber as number) - 1]
|
||||
@@ -62,7 +65,7 @@ const test = (value: string, config?: LintConfig) => {
|
||||
lineNumber: macro.endLineNumber as number,
|
||||
startColumnNumber: getColumnNumber(endLine, '%mend'),
|
||||
endColumnNumber: getColumnNumber(endLine, '%mend') + 6,
|
||||
severity: Severity.Warning
|
||||
severity
|
||||
})
|
||||
}
|
||||
})
|
||||
|
||||
@@ -9,9 +9,12 @@ import { LintConfig } from '../../types'
|
||||
const name = 'hasMacroParentheses'
|
||||
const description = 'Enforces the presence of parentheses in macro definitions.'
|
||||
const message = 'Macro definition missing parentheses'
|
||||
|
||||
const test = (value: string, config?: LintConfig) => {
|
||||
const diagnostics: Diagnostic[] = []
|
||||
const macros = parseMacros(value, config)
|
||||
const severity = config?.severityLevel[name] || Severity.Warning
|
||||
|
||||
macros.forEach((macro) => {
|
||||
if (!macro.name) {
|
||||
diagnostics.push({
|
||||
@@ -24,7 +27,7 @@ const test = (value: string, config?: LintConfig) => {
|
||||
endColumnNumber:
|
||||
getColumnNumber(macro.declarationLines![0], '%macro') +
|
||||
macro.declaration.length,
|
||||
severity: Severity.Warning
|
||||
severity
|
||||
})
|
||||
} else if (!macro.declarationLines.find((dl) => dl.includes('('))) {
|
||||
const macroNameLineIndex = macro.declarationLines.findIndex((dl) =>
|
||||
@@ -44,7 +47,7 @@ const test = (value: string, config?: LintConfig) => {
|
||||
) +
|
||||
macro.name.length -
|
||||
1,
|
||||
severity: Severity.Warning
|
||||
severity
|
||||
})
|
||||
}
|
||||
})
|
||||
|
||||
@@ -7,6 +7,7 @@ import { Severity } from '../../types/Severity'
|
||||
const name = 'lineEndings'
|
||||
const description = 'Ensures line endings conform to the configured type.'
|
||||
const message = 'Incorrect line ending - {actual} instead of {expected}'
|
||||
|
||||
const test = (value: string, config?: LintConfig) => {
|
||||
const lineEndingConfig = config?.lineEndings || LineEndings.LF
|
||||
const expectedLineEnding =
|
||||
@@ -18,8 +19,10 @@ const test = (value: string, config?: LintConfig) => {
|
||||
.replace(/\n/g, '{lf}')
|
||||
.split(new RegExp(`(?<=${expectedLineEnding})`))
|
||||
const diagnostics: Diagnostic[] = []
|
||||
const severity = config?.severityLevel[name] || Severity.Warning
|
||||
|
||||
let indexOffset = 0
|
||||
|
||||
lines.forEach((line, index) => {
|
||||
if (line.endsWith(incorrectLineEnding)) {
|
||||
diagnostics.push({
|
||||
@@ -29,7 +32,7 @@ const test = (value: string, config?: LintConfig) => {
|
||||
lineNumber: index + 1 + indexOffset,
|
||||
startColumnNumber: line.indexOf(incorrectLineEnding),
|
||||
endColumnNumber: line.indexOf(incorrectLineEnding) + 1,
|
||||
severity: Severity.Warning
|
||||
severity
|
||||
})
|
||||
} else {
|
||||
const splitLine = line.split(new RegExp(`(?<=${incorrectLineEnding})`))
|
||||
@@ -51,7 +54,7 @@ const test = (value: string, config?: LintConfig) => {
|
||||
lineNumber: index + i + 1,
|
||||
startColumnNumber: l.indexOf(incorrectLineEnding),
|
||||
endColumnNumber: l.indexOf(incorrectLineEnding) + 1,
|
||||
severity: Severity.Warning
|
||||
severity
|
||||
})
|
||||
}
|
||||
})
|
||||
|
||||
@@ -10,11 +10,14 @@ import { LineEndings } from '../../types/LineEndings'
|
||||
const name = 'noNestedMacros'
|
||||
const description = 'Enfoces the absence of nested macro definitions.'
|
||||
const message = `Macro definition for '{macro}' present in macro '{parent}'`
|
||||
|
||||
const test = (value: string, config?: LintConfig) => {
|
||||
const lineEnding = config?.lineEndings === LineEndings.CRLF ? '\r\n' : '\n'
|
||||
const lines: string[] = value ? value.split(lineEnding) : []
|
||||
const diagnostics: Diagnostic[] = []
|
||||
const macros = parseMacros(value, config)
|
||||
const severity = config?.severityLevel[name] || Severity.Warning
|
||||
|
||||
macros
|
||||
.filter((m) => !!m.parentMacro)
|
||||
.forEach((macro) => {
|
||||
@@ -34,7 +37,7 @@ const test = (value: string, config?: LintConfig) => {
|
||||
) +
|
||||
lines[(macro.startLineNumbers![0] as number) - 1].trim().length -
|
||||
1,
|
||||
severity: Severity.Warning
|
||||
severity
|
||||
})
|
||||
})
|
||||
return diagnostics
|
||||
|
||||
@@ -25,9 +25,11 @@ const validOptions = [
|
||||
const processParams = (
|
||||
content: string,
|
||||
macro: Macro,
|
||||
diagnostics: Diagnostic[]
|
||||
diagnostics: Diagnostic[],
|
||||
config?: LintConfig
|
||||
): string => {
|
||||
const declaration = macro.declaration
|
||||
const severity = config?.severityLevel[name] || Severity.Warning
|
||||
|
||||
const regExpParams = new RegExp(/(?<=\().*(?=\))/)
|
||||
const regExpParamsResult = regExpParams.exec(declaration)
|
||||
@@ -88,7 +90,7 @@ const processParams = (
|
||||
lineNumber: paramLineNumber,
|
||||
startColumnNumber: paramStartIndex + 1,
|
||||
endColumnNumber: paramEndIndex,
|
||||
severity: Severity.Warning
|
||||
severity
|
||||
})
|
||||
}
|
||||
})
|
||||
@@ -101,9 +103,11 @@ const processParams = (
|
||||
const processOptions = (
|
||||
_declaration: string,
|
||||
macro: Macro,
|
||||
diagnostics: Diagnostic[]
|
||||
diagnostics: Diagnostic[],
|
||||
config?: LintConfig
|
||||
): void => {
|
||||
let optionsPresent = _declaration.split('/')?.[1]?.trim()
|
||||
const severity = config?.severityLevel[name] || Severity.Warning
|
||||
|
||||
if (optionsPresent) {
|
||||
const regex = new RegExp(/="(.*?)"/, 'g')
|
||||
@@ -136,7 +140,7 @@ const processOptions = (
|
||||
startColumnNumber: declarationLine.indexOf(trimmedOption) + 1,
|
||||
endColumnNumber:
|
||||
declarationLine.indexOf(trimmedOption) + trimmedOption.length,
|
||||
severity: Severity.Warning
|
||||
severity
|
||||
})
|
||||
}
|
||||
})
|
||||
@@ -149,9 +153,9 @@ const test = (value: string, config?: LintConfig) => {
|
||||
const macros = parseMacros(value, config)
|
||||
|
||||
macros.forEach((macro) => {
|
||||
const _declaration = processParams(value, macro, diagnostics)
|
||||
const _declaration = processParams(value, macro, diagnostics, config)
|
||||
|
||||
processOptions(_declaration, macro, diagnostics)
|
||||
processOptions(_declaration, macro, diagnostics, config)
|
||||
})
|
||||
|
||||
return diagnostics
|
||||
|
||||
@@ -6,9 +6,11 @@ import { Severity } from '../../types/Severity'
|
||||
const name = 'indentationMultiple'
|
||||
const description = 'Ensure indentation by a multiple of the configured number.'
|
||||
const message = 'Line has incorrect indentation'
|
||||
|
||||
const test = (value: string, lineNumber: number, config?: LintConfig) => {
|
||||
if (!value.startsWith(' ')) return []
|
||||
|
||||
const severity = config?.severityLevel[name] || Severity.Warning
|
||||
const indentationMultiple = isNaN(config?.indentationMultiple as number)
|
||||
? 2
|
||||
: config!.indentationMultiple
|
||||
@@ -24,7 +26,7 @@ const test = (value: string, lineNumber: number, config?: LintConfig) => {
|
||||
lineNumber,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
severity
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@@ -6,7 +6,9 @@ import { Severity } from '../../types/Severity'
|
||||
const name = 'maxLineLength'
|
||||
const description = 'Restrict lines to the specified length.'
|
||||
const message = 'Line exceeds maximum length'
|
||||
|
||||
const test = (value: string, lineNumber: number, config?: LintConfig) => {
|
||||
const severity = config?.severityLevel[name] || Severity.Warning
|
||||
const maxLineLength = config?.maxLineLength || 80
|
||||
if (value.length <= maxLineLength) return []
|
||||
return [
|
||||
@@ -15,7 +17,7 @@ const test = (value: string, lineNumber: number, config?: LintConfig) => {
|
||||
lineNumber,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
severity
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
import { LintConfig } from '../../types'
|
||||
import { LineLintRule } from '../../types/LintRule'
|
||||
import { LintRuleType } from '../../types/LintRuleType'
|
||||
import { Severity } from '../../types/Severity'
|
||||
@@ -5,7 +6,9 @@ import { Severity } from '../../types/Severity'
|
||||
const name = 'noEncodedPasswords'
|
||||
const description = 'Disallow encoded passwords in SAS code.'
|
||||
const message = 'Line contains encoded password'
|
||||
const test = (value: string, lineNumber: number) => {
|
||||
|
||||
const test = (value: string, lineNumber: number, config?: LintConfig) => {
|
||||
const severity = config?.severityLevel[name] || Severity.Error
|
||||
const regex = new RegExp(/{sas(\d{2,4}|enc)}[^;"'\s]*/, 'gi')
|
||||
const matches = value.match(regex)
|
||||
if (!matches || !matches.length) return []
|
||||
@@ -14,7 +17,7 @@ const test = (value: string, lineNumber: number) => {
|
||||
lineNumber,
|
||||
startColumnNumber: value.indexOf(match) + 1,
|
||||
endColumnNumber: value.indexOf(match) + match.length + 1,
|
||||
severity: Severity.Error
|
||||
severity
|
||||
}))
|
||||
}
|
||||
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
import { LintConfig } from '../../types'
|
||||
import { LineLintRule } from '../../types/LintRule'
|
||||
import { LintRuleType } from '../../types/LintRuleType'
|
||||
import { Severity } from '../../types/Severity'
|
||||
@@ -5,7 +6,9 @@ import { Severity } from '../../types/Severity'
|
||||
const name = 'noTabs'
|
||||
const description = 'Disallow indenting with tabs.'
|
||||
const message = 'Line is indented with a tab'
|
||||
const test = (value: string, lineNumber: number) => {
|
||||
|
||||
const test = (value: string, lineNumber: number, config?: LintConfig) => {
|
||||
const severity = config?.severityLevel[name] || Severity.Warning
|
||||
if (!value.startsWith('\t')) return []
|
||||
return [
|
||||
{
|
||||
@@ -13,7 +16,7 @@ const test = (value: string, lineNumber: number) => {
|
||||
lineNumber,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
severity
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
import { LintConfig } from '../../types'
|
||||
import { LineLintRule } from '../../types/LintRule'
|
||||
import { LintRuleType } from '../../types/LintRuleType'
|
||||
import { Severity } from '../../types/Severity'
|
||||
@@ -5,8 +6,11 @@ import { Severity } from '../../types/Severity'
|
||||
const name = 'noTrailingSpaces'
|
||||
const description = 'Disallow trailing spaces on lines.'
|
||||
const message = 'Line contains trailing spaces'
|
||||
const test = (value: string, lineNumber: number) =>
|
||||
value.trimEnd() === value
|
||||
|
||||
const test = (value: string, lineNumber: number, config?: LintConfig) => {
|
||||
const severity = config?.severityLevel[name] || Severity.Warning
|
||||
|
||||
return value.trimEnd() === value
|
||||
? []
|
||||
: [
|
||||
{
|
||||
@@ -14,9 +18,11 @@ const test = (value: string, lineNumber: number) =>
|
||||
lineNumber,
|
||||
startColumnNumber: value.trimEnd().length + 1,
|
||||
endColumnNumber: value.length,
|
||||
severity: Severity.Warning
|
||||
severity
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
const fix = (value: string) => value.trimEnd()
|
||||
|
||||
/**
|
||||
|
||||
@@ -2,20 +2,25 @@ import { PathLintRule } from '../../types/LintRule'
|
||||
import { LintRuleType } from '../../types/LintRuleType'
|
||||
import { Severity } from '../../types/Severity'
|
||||
import path from 'path'
|
||||
import { LintConfig } from '../../types'
|
||||
|
||||
const name = 'lowerCaseFileNames'
|
||||
const description = 'Enforce the use of lower case file names.'
|
||||
const message = 'File name contains uppercase characters'
|
||||
const test = (value: string) => {
|
||||
|
||||
const test = (value: string, config?: LintConfig) => {
|
||||
const severity = config?.severityLevel[name] || Severity.Warning
|
||||
const fileName = path.basename(value)
|
||||
|
||||
if (fileName.toLocaleLowerCase() === fileName) return []
|
||||
|
||||
return [
|
||||
{
|
||||
message,
|
||||
lineNumber: 1,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
severity
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@@ -2,12 +2,16 @@ import { PathLintRule } from '../../types/LintRule'
|
||||
import { LintRuleType } from '../../types/LintRuleType'
|
||||
import { Severity } from '../../types/Severity'
|
||||
import path from 'path'
|
||||
import { LintConfig } from '../../types'
|
||||
|
||||
const name = 'noSpacesInFileNames'
|
||||
const description = 'Enforce the absence of spaces within file names.'
|
||||
const message = 'File name contains spaces'
|
||||
const test = (value: string) => {
|
||||
|
||||
const test = (value: string, config?: LintConfig) => {
|
||||
const severity = config?.severityLevel[name] || Severity.Warning
|
||||
const fileName = path.basename(value)
|
||||
|
||||
if (fileName.includes(' ')) {
|
||||
return [
|
||||
{
|
||||
@@ -15,7 +19,7 @@ const test = (value: string) => {
|
||||
lineNumber: 1,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
severity
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
import { LineEndings } from './LineEndings'
|
||||
import { LintConfig } from './LintConfig'
|
||||
import { LintRuleType } from './LintRuleType'
|
||||
import { Severity } from './Severity'
|
||||
|
||||
describe('LintConfig', () => {
|
||||
it('should create an empty instance', () => {
|
||||
@@ -123,6 +124,23 @@ describe('LintConfig', () => {
|
||||
expect(config.lineEndings).toEqual(LineEndings.CRLF)
|
||||
})
|
||||
|
||||
it('should create an instance with the severityLevel config', () => {
|
||||
const config = new LintConfig({
|
||||
severityLevel: {
|
||||
hasDoxygenHeader: 'warn',
|
||||
maxLineLength: 'error',
|
||||
noTrailingSpaces: 'error'
|
||||
}
|
||||
})
|
||||
|
||||
expect(config).toBeTruthy()
|
||||
expect(config.severityLevel).toEqual({
|
||||
hasDoxygenHeader: Severity.Warning,
|
||||
maxLineLength: Severity.Error,
|
||||
noTrailingSpaces: Severity.Error
|
||||
})
|
||||
})
|
||||
|
||||
it('should create an instance with the line endings set to LF by default', () => {
|
||||
const config = new LintConfig({})
|
||||
|
||||
|
||||
@@ -16,6 +16,8 @@ import {
|
||||
import { lowerCaseFileNames, noSpacesInFileNames } from '../rules/path'
|
||||
import { LineEndings } from './LineEndings'
|
||||
import { FileLintRule, LineLintRule, PathLintRule } from './LintRule'
|
||||
import { getDefaultHeader } from '../utils'
|
||||
import { Severity } from './Severity'
|
||||
|
||||
/**
|
||||
* LintConfig is the logical representation of the .sasjslint file.
|
||||
@@ -32,6 +34,8 @@ export class LintConfig {
|
||||
readonly maxLineLength: number = 80
|
||||
readonly indentationMultiple: number = 2
|
||||
readonly lineEndings: LineEndings = LineEndings.LF
|
||||
readonly defaultHeader: string = getDefaultHeader()
|
||||
readonly severityLevel: { [key: string]: Severity } = {}
|
||||
|
||||
constructor(json?: any) {
|
||||
if (json?.ignoreList) {
|
||||
@@ -87,6 +91,10 @@ export class LintConfig {
|
||||
this.fileLintRules.push(hasDoxygenHeader)
|
||||
}
|
||||
|
||||
if (json?.defaultHeader) {
|
||||
this.defaultHeader = json.defaultHeader
|
||||
}
|
||||
|
||||
if (json?.noSpacesInFileNames) {
|
||||
this.pathLintRules.push(noSpacesInFileNames)
|
||||
}
|
||||
@@ -110,5 +118,12 @@ export class LintConfig {
|
||||
if (json?.strictMacroDefinition) {
|
||||
this.fileLintRules.push(strictMacroDefinition)
|
||||
}
|
||||
|
||||
if (json?.severityLevel) {
|
||||
for (const [rule, severity] of Object.entries(json.severityLevel)) {
|
||||
if (severity === 'warn') this.severityLevel[rule] = Severity.Warning
|
||||
if (severity === 'error') this.severityLevel[rule] = Severity.Error
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -36,5 +36,5 @@ export interface FileLintRule extends LintRule {
|
||||
*/
|
||||
export interface PathLintRule extends LintRule {
|
||||
type: LintRuleType.Path
|
||||
test: (value: string) => Diagnostic[]
|
||||
test: (value: string, config?: LintConfig) => Diagnostic[]
|
||||
}
|
||||
|
||||
@@ -3,6 +3,9 @@ import { LintConfig } from '../types/LintConfig'
|
||||
import { readFile } from '@sasjs/utils/file'
|
||||
import { getProjectRoot } from './getProjectRoot'
|
||||
|
||||
export const getDefaultHeader = () =>
|
||||
`/**{lineEnding} @file{lineEnding} @brief <Your brief here>{lineEnding} <h4> SAS Macros </h4>{lineEnding}**/`
|
||||
|
||||
/**
|
||||
* Default configuration that is used when a .sasjslint file is not found
|
||||
*/
|
||||
@@ -18,7 +21,8 @@ export const DefaultLintConfiguration = {
|
||||
hasMacroNameInMend: true,
|
||||
noNestedMacros: true,
|
||||
hasMacroParentheses: true,
|
||||
strictMacroDefinition: true
|
||||
strictMacroDefinition: true,
|
||||
defaultHeader: getDefaultHeader()
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
Reference in New Issue
Block a user