1
0
mirror of https://github.com/sasjs/lint.git synced 2025-12-10 17:34:36 +00:00

Compare commits

...

9 Commits

Author SHA1 Message Date
Allan Bowe
f59fd4c3f3 Merge pull request #191 from sasjs/issue-190
fix: added more gremlin characters
2022-12-30 11:49:01 +01:00
5245246818 chore: fix specs 2022-12-29 18:52:21 +05:00
636703b326 chore: specs fix 2022-12-29 00:49:40 +05:00
24fba7867c fix: update the logic for default values of rules 2022-12-29 00:49:13 +05:00
5c44ec400d chore: quick fix 2022-12-29 00:47:54 +05:00
c0fdfc6ac9 fix: pass lint config to lintFile calling from formatFile 2022-12-29 00:46:50 +05:00
4b16e0c52a chore: typo fix 2022-12-27 23:55:36 +05:00
8cf4f34e30 fix: noGremlins should be true by default even though if its not defined in .sasjslint 2022-12-27 23:29:55 +05:00
97e3490a8d fix: add few more gremlins 2022-12-27 23:22:40 +05:00
11 changed files with 403 additions and 168 deletions

View File

@@ -32,16 +32,8 @@ describe('formatFile', () => {
const expectedContent = `/**\r\n @file\r\n @brief <Your brief here>\r\n <h4> SAS Macros </h4>\r\n**/\r\n%macro somemacro();\r\n%put 'hello';\r\n%mend;`
const expectedResult = {
updatedFilePaths: [path.join(__dirname, 'format-file-config.sas')],
fixedDiagnosticsCount: 2,
unfixedDiagnostics: [
{
endColumnNumber: 7,
lineNumber: 8,
message: '%mend statement is missing macro name - somemacro',
severity: 1,
startColumnNumber: 1
}
]
fixedDiagnosticsCount: 4,
unfixedDiagnostics: []
}
await createFile(path.join(__dirname, 'format-file-config.sas'), content)

View File

@@ -16,7 +16,7 @@ export const formatFile = async (
configuration?: LintConfig
): Promise<FormatResult> => {
const config = configuration || (await getLintConfig())
const diagnosticsBeforeFormat = await lintFile(filePath)
const diagnosticsBeforeFormat = await lintFile(filePath, config)
const diagnosticsCountBeforeFormat = diagnosticsBeforeFormat.length
const text = await readFile(filePath)
@@ -25,7 +25,7 @@ export const formatFile = async (
await createFile(filePath, formattedText)
const diagnosticsAfterFormat = await lintFile(filePath)
const diagnosticsAfterFormat = await lintFile(filePath, config)
const diagnosticsCountAfterFormat = diagnosticsAfterFormat.length
const fixedDiagnosticsCount =

View File

@@ -30,7 +30,7 @@ export const processLine = (config: LintConfig, line: string): string => {
config.lineLintRules
.filter((r) => !!r.fix)
.forEach((rule) => {
processedLine = rule.fix!(line, config)
processedLine = rule.fix!(processedLine, config)
})
return processedLine

View File

@@ -2,6 +2,7 @@ import { Diagnostic, LintConfig } from '../../types'
import { LineLintRule } from '../../types/LintRule'
import { LintRuleType } from '../../types/LintRuleType'
import { Severity } from '../../types/Severity'
import { gremlinCharacters } from '../../utils'
const name = 'noGremlins'
const description = 'Disallow characters specified in gremlins array'
@@ -56,73 +57,3 @@ export const noGremlins: LineLintRule = {
}
const charFromHex = (hexCode: string) => String.fromCodePoint(parseInt(hexCode))
const gremlinCharacters = {
'0x2013': {
description: 'en dash'
},
'0x2018': {
description: 'left single quotation mark'
},
'0x2019': {
description: 'right single quotation mark'
},
'0x2029': {
zeroWidth: true,
description: 'paragraph separator'
},
'0x2066': {
zeroWidth: true,
description: 'Left to right'
},
'0x2069': {
zeroWidth: true,
description: 'Pop directional'
},
'0x0003': {
description: 'end of text'
},
'0x000b': {
description: 'line tabulation'
},
'0x00a0': {
description: 'non breaking space'
},
'0x00ad': {
description: 'soft hyphen'
},
'0x200b': {
zeroWidth: true,
description: 'zero width space'
},
'0x200c': {
zeroWidth: true,
description: 'zero width non-joiner'
},
'0x200e': {
zeroWidth: true,
description: 'left-to-right mark'
},
'0x201c': {
description: 'left double quotation mark'
},
'0x201d': {
description: 'right double quotation mark'
},
'0x202c': {
zeroWidth: true,
description: 'pop directional formatting'
},
'0x202d': {
zeroWidth: true,
description: 'left-to-right override'
},
'0x202e': {
zeroWidth: true,
description: 'right-to-left override'
},
'0xfffc': {
zeroWidth: true,
description: 'object replacement character'
}
}

View File

@@ -4,96 +4,75 @@ import { LintRuleType } from './LintRuleType'
import { Severity } from './Severity'
describe('LintConfig', () => {
it('should create an empty instance', () => {
it('should create an instance with default values when no configuration is provided', () => {
const config = new LintConfig()
expect(config).toBeTruthy()
expect(config.fileLintRules.length).toEqual(0)
expect(config.lineLintRules.length).toEqual(0)
})
it('should create an instance with the noTrailingSpaces flag set', () => {
const config = new LintConfig({ noTrailingSpaces: true })
it('should create an instance with the noTrailingSpaces flag off', () => {
const config = new LintConfig({ noTrailingSpaces: false })
expect(config).toBeTruthy()
expect(config.lineLintRules.length).toEqual(1)
expect(config.lineLintRules[0].name).toEqual('noTrailingSpaces')
expect(config.lineLintRules[0].type).toEqual(LintRuleType.Line)
expect(config.fileLintRules.length).toEqual(0)
expect(config.lineLintRules.length).toBeGreaterThan(0)
expect(config.fileLintRules.length).toBeGreaterThan(0)
expect(
config.lineLintRules.find((rule) => rule.name === 'noTrailingSpaces')
).toBeUndefined()
})
it('should create an instance with the noEncodedPasswords flag set', () => {
const config = new LintConfig({ noEncodedPasswords: true })
it('should create an instance with the noEncodedPasswords flag off', () => {
const config = new LintConfig({ noEncodedPasswords: false })
expect(config).toBeTruthy()
expect(config.lineLintRules.length).toEqual(1)
expect(config.lineLintRules[0].name).toEqual('noEncodedPasswords')
expect(config.lineLintRules[0].type).toEqual(LintRuleType.Line)
expect(config.fileLintRules.length).toEqual(0)
expect(config.lineLintRules.length).toBeGreaterThan(0)
expect(config.fileLintRules.length).toBeGreaterThan(0)
expect(
config.lineLintRules.find((rule) => rule.name === 'noEncodedPasswords')
).toBeUndefined()
})
it('should create an instance with the hasDoxygenHeader flag set', () => {
const config = new LintConfig({ hasDoxygenHeader: true })
it('should create an instance with the hasDoxygenHeader flag off', () => {
const config = new LintConfig({ hasDoxygenHeader: false })
expect(config).toBeTruthy()
expect(config.lineLintRules.length).toEqual(0)
expect(config.fileLintRules.length).toEqual(1)
expect(config.fileLintRules[0].name).toEqual('hasDoxygenHeader')
expect(config.fileLintRules[0].type).toEqual(LintRuleType.File)
})
it('should create an instance with the hasMacroNameInMend flag set', () => {
const config = new LintConfig({ hasMacroNameInMend: true })
expect(config).toBeTruthy()
expect(config.lineLintRules.length).toEqual(0)
expect(config.fileLintRules.length).toEqual(1)
expect(config.fileLintRules[0].name).toEqual('hasMacroNameInMend')
expect(config.fileLintRules[0].type).toEqual(LintRuleType.File)
expect(config.lineLintRules.length).toBeGreaterThan(0)
expect(config.fileLintRules.length).toBeGreaterThan(0)
expect(
config.fileLintRules.find((rule) => rule.name === 'hasDoxygenHeader')
).toBeUndefined()
})
it('should create an instance with the hasMacroNameInMend flag off', () => {
const config = new LintConfig({ hasMacroNameInMend: false })
expect(config).toBeTruthy()
expect(config.lineLintRules.length).toEqual(0)
expect(config.fileLintRules.length).toEqual(0)
})
it('should create an instance with the noNestedMacros flag set', () => {
const config = new LintConfig({ noNestedMacros: true })
expect(config).toBeTruthy()
expect(config.lineLintRules.length).toEqual(0)
expect(config.fileLintRules.length).toEqual(1)
expect(config.fileLintRules[0].name).toEqual('noNestedMacros')
expect(config.fileLintRules[0].type).toEqual(LintRuleType.File)
expect(config.lineLintRules.length).toBeGreaterThan(0)
expect(config.fileLintRules.length).toBeGreaterThan(0)
expect(
config.fileLintRules.find((rule) => rule.name === 'hasMacroNameInMend')
).toBeUndefined()
})
it('should create an instance with the noNestedMacros flag off', () => {
const config = new LintConfig({ noNestedMacros: false })
expect(config).toBeTruthy()
expect(config.lineLintRules.length).toEqual(0)
expect(config.fileLintRules.length).toEqual(0)
})
it('should create an instance with the hasMacroParentheses flag set', () => {
const config = new LintConfig({ hasMacroParentheses: true })
expect(config).toBeTruthy()
expect(config.lineLintRules.length).toEqual(0)
expect(config.fileLintRules.length).toEqual(1)
expect(config.fileLintRules[0].name).toEqual('hasMacroParentheses')
expect(config.fileLintRules[0].type).toEqual(LintRuleType.File)
expect(config.lineLintRules.length).toBeGreaterThan(0)
expect(config.fileLintRules.length).toBeGreaterThan(0)
expect(
config.fileLintRules.find((rule) => rule.name === 'noNestedMacros')
).toBeUndefined()
})
it('should create an instance with the hasMacroParentheses flag off', () => {
const config = new LintConfig({ hasMacroParentheses: false })
expect(config).toBeTruthy()
expect(config.lineLintRules.length).toEqual(0)
expect(config.fileLintRules.length).toEqual(0)
expect(config.lineLintRules.length).toBeGreaterThan(0)
expect(config.fileLintRules.length).toBeGreaterThan(0)
expect(
config.fileLintRules.find((rule) => rule.name === 'hasMacroParentheses')
).toBeUndefined()
})
it('should create an instance with the indentation multiple set', () => {
@@ -166,11 +145,12 @@ describe('LintConfig', () => {
indentationMultiple: 2,
hasMacroNameInMend: true,
noNestedMacros: true,
hasMacroParentheses: true
hasMacroParentheses: true,
noGremlins: true
})
expect(config).toBeTruthy()
expect(config.lineLintRules.length).toEqual(5)
expect(config.lineLintRules.length).toEqual(6)
expect(config.lineLintRules[0].name).toEqual('noTrailingSpaces')
expect(config.lineLintRules[0].type).toEqual(LintRuleType.Line)
expect(config.lineLintRules[1].name).toEqual('noEncodedPasswords')
@@ -181,16 +161,22 @@ describe('LintConfig', () => {
expect(config.lineLintRules[3].type).toEqual(LintRuleType.Line)
expect(config.lineLintRules[4].name).toEqual('indentationMultiple')
expect(config.lineLintRules[4].type).toEqual(LintRuleType.Line)
expect(config.lineLintRules[5].name).toEqual('noGremlins')
expect(config.lineLintRules[5].type).toEqual(LintRuleType.Line)
expect(config.fileLintRules.length).toEqual(4)
expect(config.fileLintRules[0].name).toEqual('hasDoxygenHeader')
expect(config.fileLintRules.length).toEqual(6)
expect(config.fileLintRules[0].name).toEqual('lineEndings')
expect(config.fileLintRules[0].type).toEqual(LintRuleType.File)
expect(config.fileLintRules[1].name).toEqual('hasMacroNameInMend')
expect(config.fileLintRules[1].name).toEqual('hasDoxygenHeader')
expect(config.fileLintRules[1].type).toEqual(LintRuleType.File)
expect(config.fileLintRules[2].name).toEqual('noNestedMacros')
expect(config.fileLintRules[2].name).toEqual('hasMacroNameInMend')
expect(config.fileLintRules[2].type).toEqual(LintRuleType.File)
expect(config.fileLintRules[3].name).toEqual('hasMacroParentheses')
expect(config.fileLintRules[3].name).toEqual('noNestedMacros')
expect(config.fileLintRules[3].type).toEqual(LintRuleType.File)
expect(config.fileLintRules[4].name).toEqual('hasMacroParentheses')
expect(config.fileLintRules[4].type).toEqual(LintRuleType.File)
expect(config.fileLintRules[5].name).toEqual('strictMacroDefinition')
expect(config.fileLintRules[5].type).toEqual(LintRuleType.File)
expect(config.pathLintRules.length).toEqual(2)
expect(config.pathLintRules[0].name).toEqual('noSpacesInFileNames')

View File

@@ -53,23 +53,25 @@ export class LintConfig {
}
}
if (json?.noTrailingSpaces) {
if (json?.noTrailingSpaces !== false) {
this.lineLintRules.push(noTrailingSpaces)
}
if (json?.noEncodedPasswords) {
if (json?.noEncodedPasswords !== false) {
this.lineLintRules.push(noEncodedPasswords)
}
if (json?.noTabs || json?.noTabIndentation) {
this.lineLintRules.push(noTabs)
this.lineLintRules.push(noTabs)
if (json?.noTabs === false || json?.noTabIndentation === false) {
this.lineLintRules.pop()
}
if (json?.maxLineLength) {
this.lineLintRules.push(maxLineLength)
if (!isNaN(json?.maxLineLength)) {
this.maxLineLength = json.maxLineLength
this.lineLintRules.push(maxLineLength)
}
this.fileLintRules.push(lineEndings)
if (json?.lineEndings) {
if (
json.lineEndings !== LineEndings.LF &&
@@ -80,15 +82,14 @@ export class LintConfig {
)
}
this.lineEndings = json.lineEndings
this.fileLintRules.push(lineEndings)
}
this.lineLintRules.push(indentationMultiple)
if (!isNaN(json?.indentationMultiple)) {
this.indentationMultiple = json.indentationMultiple as number
this.lineLintRules.push(indentationMultiple)
}
if (json?.hasDoxygenHeader) {
if (json?.hasDoxygenHeader !== false) {
this.fileLintRules.push(hasDoxygenHeader)
}
@@ -96,11 +97,11 @@ export class LintConfig {
this.defaultHeader = json.defaultHeader
}
if (json?.noSpacesInFileNames) {
if (json?.noSpacesInFileNames !== false) {
this.pathLintRules.push(noSpacesInFileNames)
}
if (json?.lowerCaseFileNames) {
if (json?.lowerCaseFileNames !== false) {
this.pathLintRules.push(lowerCaseFileNames)
}
@@ -108,19 +109,19 @@ export class LintConfig {
this.fileLintRules.push(hasMacroNameInMend)
}
if (json?.noNestedMacros) {
if (json?.noNestedMacros !== false) {
this.fileLintRules.push(noNestedMacros)
}
if (json?.hasMacroParentheses) {
if (json?.hasMacroParentheses !== false) {
this.fileLintRules.push(hasMacroParentheses)
}
if (json?.strictMacroDefinition) {
if (json?.strictMacroDefinition !== false) {
this.fileLintRules.push(strictMacroDefinition)
}
if (json?.noGremlins) {
if (json?.noGremlins !== false) {
this.lineLintRules.push(noGremlins)
}

View File

@@ -2,8 +2,8 @@ import * as fileModule from '@sasjs/utils/file'
import { LintConfig } from '../types/LintConfig'
import { getLintConfig } from './getLintConfig'
const expectedFileLintRulesCount = 5
const expectedLineLintRulesCount = 5
const expectedFileLintRulesCount = 6
const expectedLineLintRulesCount = 6
const expectedPathLintRulesCount = 2
describe('getLintConfig', () => {

View File

@@ -22,6 +22,7 @@ export const DefaultLintConfiguration = {
noNestedMacros: true,
hasMacroParentheses: true,
strictMacroDefinition: true,
noGremlins: true,
defaultHeader: getDefaultHeader()
}

View File

@@ -0,0 +1,314 @@
// Used https://compart.com/en/unicode to find the to find the description of each gremlin
// List of gremlins was deduced from https://github.com/redoPop/SublimeGremlins/blob/main/Gremlins.py#L13
export const gremlinCharacters = {
'0x0003': {
description: 'End of Text'
},
'0x000b': {
description: 'Line Tabulation'
},
'0x007f': {
description: 'Delete'
},
'0x0080': {
description: 'Padding'
},
'0x0081': {
description: 'High Octet Preset'
},
'0x0082': {
description: 'Break Permitted Here'
},
'0x0083': {
description: 'No Break Here'
},
'0x0084': {
description: 'Index'
},
'0x0085': {
description: 'Next Line'
},
'0x0086': {
description: 'Start of Selected Area'
},
'0x0087': {
description: 'End of Selected Area'
},
'0x0088': {
description: 'Character Tabulation Set'
},
'0x0089': {
description: 'Character Tabulation with Justification'
},
'0x008a': {
description: 'Line Tabulation Set'
},
'0x008b': {
description: 'Partial Line Down'
},
'0x008c': {
description: 'Partial Line Backward'
},
'0x008d': {
description: 'Reverse Index'
},
'0x008e': {
description: 'Single Shift Two'
},
'0x008f': {
description: 'Single Shift Three'
},
'0x0090': {
description: 'Device Control String'
},
'0x0091': {
description: 'Private Use One'
},
'0x0092': {
description: 'Private Use Two'
},
'0x0093': {
description: 'Set Transmit State'
},
'0x0094': {
description: 'Cancel Character'
},
'0x0095': {
description: 'Message Waiting'
},
'0x0096': {
description: 'Start of Guarded Area'
},
'0x0097': {
description: 'End of Guarded Area'
},
'0x0098': {
description: 'Start of String'
},
'0x0099': {
description: 'Single Graphic Character Introducer'
},
'0x009a': {
description: 'Single Character Introducer'
},
'0x009b': {
description: 'Control Sequence Introducer'
},
'0x009c': {
description: 'String Terminator'
},
'0x009d': {
description: 'Operating System Command'
},
'0x009e': {
description: 'Privacy Message'
},
'0x009f': {
description: 'Application Program Command'
},
'0x00a0': {
description: 'non breaking space'
},
'0x00ad': {
description: 'Soft Hyphen'
},
'0x2000': {
description: 'En Quad'
},
'0x2001': {
description: 'Em Quad'
},
'0x2002': {
description: 'En Space'
},
'0x2003': {
description: 'Em Space'
},
'0x2004': {
description: 'Three-Per-Em Space'
},
'0x2005': {
description: 'Four-Per-Em Space'
},
'0x2006': {
description: 'Six-Per-Em Space'
},
'0x2007': {
description: 'Figure Space'
},
'0x2008': {
description: 'Punctuation Space'
},
'0x2009': {
description: 'Thin Space'
},
'0x200a': {
description: 'Hair Space'
},
'0x200b': {
description: 'Zero Width Space'
},
'0x200c': {
description: 'Zero Width Non-Joiner'
},
'0x200d': {
description: 'Zero Width Joiner'
},
'0x200e': {
description: 'Left-to-Right Mark'
},
'0x200f': {
description: 'Right-to-Left Mark'
},
'0x2013': {
description: 'En Dash'
},
'0x2018': {
description: 'Left Single Quotation Mark'
},
'0x2019': {
description: 'Right Single Quotation Mark'
},
'0x201c': {
description: 'Left Double Quotation Mark'
},
'0x201d': {
description: 'Right Double Quotation Mark'
},
'0x2028': {
description: 'Line Separator'
},
'0x2029': {
description: 'Paragraph Separator'
},
'0x202a': {
description: 'Left-to-Right Embedding'
},
'0x202b': {
description: 'Right-to-Left Embedding'
},
'0x202c': {
description: 'Pop Directional Formatting'
},
'0x202d': {
description: 'Left-to-Right Override'
},
'0x202e': {
description: 'Right-to-Left Override'
},
'0x202f': {
description: 'Narrow No-Break Space'
},
'0x205f': {
description: 'Medium Mathematical Space'
},
'0x2060': {
description: 'Word Joiner'
},
'0x2061': {
description: 'Function Application'
},
'0x2062': {
description: 'Invisible Times'
},
'0x2063': {
description: 'Invisible Separator'
},
'0x2064': {
description: 'Invisible Plus'
},
'0x2066': {
description: 'Left-to-Right Isolate'
},
'0x2067': {
description: 'Right-to-Left Isolate'
},
'0x2068': {
description: 'First Strong Isolate '
},
'0x2069': {
description: 'Pop Directional Isolate'
},
'0x206a': {
description: 'Inhibit Symmetric Swapping'
},
'0x206b': {
description: 'Activate Symmetric Swapping'
},
'0x206c': {
description: 'Inhibit Arabic Form Shaping'
},
'0x206d': {
description: 'Activate Arabic Form Shaping'
},
'0x206e': {
description: 'National Digit Shapes'
},
'0x206f': {
description: 'Nominal Digit Shapes'
},
'0x2800': {
description: 'Braille Pattern Blank'
},
'0x3000': {
description: 'Ideographic Space'
},
'0x3164': {
description: 'Hangul Filler'
},
'0xfe00': {
description: 'Variation Selector-1'
},
'0xfe01': {
description: 'Variation Selector-2'
},
'0xfe02': {
description: 'Variation Selector-3'
},
'0xfe03': {
description: 'Variation Selector-4'
},
'0xfe04': {
description: 'Variation Selector-5'
},
'0xfe05': {
description: 'Variation Selector-6'
},
'0xfe06': {
description: 'Variation Selector-7'
},
'0xfe07': {
description: 'Variation Selector-8'
},
'0xfe08': {
description: 'Variation Selector-9'
},
'0xfe09': {
description: 'Variation Selector-10'
},
'0xfe0a': {
description: 'Variation Selector-11'
},
'0xfe0b': {
description: 'Variation Selector-12 '
},
'0xfe0c': {
description: 'Variation Selector-13'
},
'0xfe0d': {
description: 'Variation Selector-14'
},
'0xfe0e': {
description: 'Variation Selector-15'
},
'0xfe0f': {
description: 'Variation Selector-16'
},
'0xfeff': {
description: 'Zero Width No-Break Space'
},
'0xfffc': {
description: 'Object Replacement Character'
}
}

View File

@@ -1,6 +1,7 @@
export * from './asyncForEach'
export * from './getLintConfig'
export * from './getProjectRoot'
export * from './gremlinCharacters'
export * from './isIgnored'
export * from './listSasFiles'
export * from './splitText'

View File

@@ -8,10 +8,19 @@ import { LineEndings } from '../types/LineEndings'
*/
export const splitText = (text: string, config: LintConfig): string[] => {
if (!text) return []
const expectedLineEndings =
config.lineEndings === LineEndings.LF ? '\n' : '\r\n'
const incorrectLineEndings = expectedLineEndings === '\n' ? '\r\n' : '\n'
return text
.replace(new RegExp(incorrectLineEndings, 'g'), expectedLineEndings)
.split(expectedLineEndings)
text = text.replace(
new RegExp(incorrectLineEndings, 'g'),
expectedLineEndings
)
// splitting text on '\r\n' was causing some problem
// as it was retaining carriage return at the end of each line
// so, removed the carriage returns from text and splitted on line feed (lf)
return text.replace(/\r/g, '').split(/\n/)
}