fix(strictMacroDefinition): moved from lineRules to fileRules

src/rules/file/strictMacroDefinition.ts

@@ -0,0 +1,140 @@
+import { Diagnostic } from '../../types/Diagnostic'
+import { LintConfig } from '../../types'
+import { FileLintRule } from '../../types/LintRule'
+import { LintRuleType } from '../../types/LintRuleType'
+import { Severity } from '../../types/Severity'
+import { parseMacros } from '../../utils/parseMacros'
+
+const name = 'strictMacroDefinition'
+const description = 'Enforce strictly rules of macro definition syntax.'
+const message = 'Incorrent Macro Definition Syntax'
+
+const validOptions = [
+  'CMD',
+  'DES',
+  'MINDELIMITER',
+  'MINOPERATOR',
+  'NOMINOPERATOR',
+  'PARMBUFF',
+  'SECURE',
+  'NOSECURE',
+  'STMT',
+  'SOURCE',
+  'SRC',
+  'STORE'
+]
+
+const test = (value: string, config?: LintConfig) => {
+  const diagnostics: Diagnostic[] = []
+
+  const macros = parseMacros(value, config)
+
+  macros.forEach((macro) => {
+    const declaration = macro.declaration
+
+    const regExpParams = new RegExp(/\((.*?)\)/)
+    const regExpParamsResult = regExpParams.exec(declaration)
+
+    let _declaration = declaration
+    if (regExpParamsResult) {
+      const paramsPresent = regExpParamsResult[1]
+
+      const paramsTrimmed = paramsPresent.trim()
+      const params = paramsTrimmed.split(',')
+      params.forEach((param) => {
+        const trimedParam = param.split('=')[0].trim()
+
+        let paramLineNumber: number = 1,
+          paramStartIndex: number = 1,
+          paramEndIndex: number = value.length
+
+        if (
+          macro.declarationLines.findIndex(
+            (dl) => dl.indexOf(trimedParam) !== -1
+          ) === -1
+        ) {
+          const comment = '/\\*(.*?)\\*/'
+          for (let i = 1; i < trimedParam.length; i++) {
+            const paramWithComment =
+              trimedParam.slice(0, i) + comment + trimedParam.slice(i)
+            const regEx = new RegExp(paramWithComment)
+
+            const declarationLineIndex = macro.declarationLines.findIndex(
+              (dl) => !!regEx.exec(dl)
+            )
+
+            if (declarationLineIndex !== -1) {
+              const declarationLine =
+                macro.declarationLines[declarationLineIndex]
+              const partFound = regEx.exec(declarationLine)![0]
+
+              paramLineNumber = macro.startLineNumbers[declarationLineIndex]
+              paramStartIndex = declarationLine.indexOf(partFound)
+              paramEndIndex =
+                declarationLine.indexOf(partFound) + partFound.length
+              break
+            }
+          }
+        } else {
+          const declarationLineIndex = macro.declarationLines.findIndex(
+            (dl) => dl.indexOf(trimedParam) !== -1
+          )
+          const declarationLine = macro.declarationLines[declarationLineIndex]
+          paramLineNumber = macro.startLineNumbers[declarationLineIndex]
+
+          paramStartIndex = declarationLine.indexOf(trimedParam)
+          paramEndIndex =
+            declarationLine.indexOf(trimedParam) + trimedParam.length
+        }
+
+        if (trimedParam.includes(' ')) {
+          diagnostics.push({
+            message: `Param '${trimedParam}' cannot have space`,
+            lineNumber: paramLineNumber,
+            startColumnNumber: paramStartIndex + 1,
+            endColumnNumber: paramEndIndex,
+            severity: Severity.Warning
+          })
+        }
+      })
+
+      _declaration = declaration.split(`(${paramsPresent})`)[1]
+    }
+
+    const optionsPresent = _declaration.split('/')?.[1]?.trim().split(' ')
+
+    optionsPresent
+      ?.filter((o) => !!o)
+      .forEach((option) => {
+        const trimmedOption = option.trim()
+        if (!validOptions.includes(trimmedOption.toUpperCase())) {
+          const declarationLineIndex = macro.declarationLines.findIndex(
+            (dl) => dl.indexOf(trimmedOption) !== -1
+          )
+          const declarationLine = macro.declarationLines[declarationLineIndex]
+
+          diagnostics.push({
+            message: `Option '${trimmedOption}' is not valid`,
+            lineNumber: macro.startLineNumbers[declarationLineIndex],
+            startColumnNumber: declarationLine.indexOf(trimmedOption) + 1,
+            endColumnNumber:
+              declarationLine.indexOf(trimmedOption) + trimmedOption.length,
+            severity: Severity.Warning
+          })
+        }
+      })
+  })
+
+  return diagnostics
+}
+
+/**
+ * Lint rule that checks if a line has followed syntax for macro definition
+ */
+export const strictMacroDefinition: FileLintRule = {
+  type: LintRuleType.File,
+  name,
+  description,
+  message,
+  test
+}