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

fix: doxygen header enforces double asterisks

This commit is contained in:
Saad Jutt
2021-06-14 18:06:37 +05:00
parent c2d368327b
commit be9d5b8e68
2 changed files with 78 additions and 5 deletions

View File

@@ -10,10 +10,28 @@ 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) => {
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'
try {
const hasFileHeader = value.trimStart().startsWith('/*')
const hasFileHeader = value.trimStart().startsWith('/**')
if (hasFileHeader) return []
const hasFileHeaderWithSingleAsterisk = value.trimStart().startsWith('/*')
if (hasFileHeaderWithSingleAsterisk)
return [
{
message: messageForSingleAsterisk,
lineNumber:
(value.split('/*')![0]!.match(new RegExp(lineEnding, 'g')) ?? [])
.length + 1,
startColumnNumber: 1,
endColumnNumber: 1,
severity: Severity.Warning
}
]
return [
{
message,
@@ -37,9 +55,12 @@ const test = (value: string) => {
}
const fix = (value: string, config?: LintConfig): string => {
if (test(value).length === 0) {
const result = test(value, config)
if (result.length === 0) {
return value
}
} else if (result[0].message == messageForSingleAsterisk)
return value.replace('/*', '/**').replace('*/', '**/')
const lineEndingConfig = config?.lineEndings || LineEndings.LF
const lineEnding = lineEndingConfig === LineEndings.LF ? '\n' : '\r\n'