1
0
mirror of https://github.com/sasjs/lint.git synced 2026-01-15 08:10:05 +00:00

chore(*): organise rules into folders by type

This commit is contained in:
Krishna Acondy
2021-04-07 16:34:33 +01:00
parent cc33ebb6e6
commit c9b6c3af95
26 changed files with 80 additions and 66 deletions

View File

@@ -0,0 +1,44 @@
import { FileLintRule } from '../../types/LintRule'
import { LintRuleType } from '../../types/LintRuleType'
import { Severity } from '../../types/Severity'
const name = 'hasDoxygenHeader'
const description =
'Enforce the presence of a Doxygen header at the start of each file.'
const message = 'File missing Doxygen header'
const test = (value: string) => {
try {
const hasFileHeader = value.trimStart().startsWith('/*')
if (hasFileHeader) return []
return [
{
message,
lineNumber: 1,
startColumnNumber: 1,
endColumnNumber: 1,
severity: Severity.Warning
}
]
} catch (e) {
return [
{
message,
lineNumber: 1,
startColumnNumber: 1,
endColumnNumber: 1,
severity: Severity.Warning
}
]
}
}
/**
* Lint rule that checks for the presence of a Doxygen header in a given file.
*/
export const hasDoxygenHeader: FileLintRule = {
type: LintRuleType.File,
name,
description,
message,
test
}