chore: Code Refactor

src/rules/file/strictMacroDefinition.ts

@@ -1,8 +1,6 @@
-import { Diagnostic } from '../../types/Diagnostic'
-import { LintConfig } from '../../types'
+import { Diagnostic, LintConfig, Macro, Severity } 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'
@@ -24,12 +22,11 @@ const validOptions = [
   'STORE'
 ]
 
-const test = (value: string, config?: LintConfig) => {
-  const diagnostics: Diagnostic[] = []
-
-  const macros = parseMacros(value, config)
-
-  macros.forEach((macro) => {
+const processParams = (
+  content: string,
+  macro: Macro,
+  diagnostics: Diagnostic[]
+): string => {
   const declaration = macro.declaration
 
   const regExpParams = new RegExp(/(?<=\().*(?=\))/)
@@ -39,14 +36,13 @@ const test = (value: string, config?: LintConfig) => {
   if (regExpParamsResult) {
     const paramsPresent = regExpParamsResult[0]
 
-      const paramsTrimmed = paramsPresent.trim()
-      const params = paramsTrimmed.split(',')
+    const params = paramsPresent.trim().split(',')
     params.forEach((param) => {
       const trimedParam = param.split('=')[0].trim()
 
       let paramLineNumber: number = 1,
         paramStartIndex: number = 1,
-          paramEndIndex: number = value.length
+        paramEndIndex: number = content.length
 
       if (
         macro.declarationLines.findIndex(
@@ -64,8 +60,7 @@ const test = (value: string, config?: LintConfig) => {
           )
 
           if (declarationLineIndex !== -1) {
-              const declarationLine =
-                macro.declarationLines[declarationLineIndex]
+            const declarationLine = macro.declarationLines[declarationLineIndex]
             const partFound = regEx.exec(declarationLine)![0]
 
             paramLineNumber = macro.startLineNumbers[declarationLineIndex]
@@ -100,7 +95,14 @@ const test = (value: string, config?: LintConfig) => {
 
     _declaration = declaration.split(`(${paramsPresent})`)[1]
   }
+  return _declaration
+}
 
+const processOptions = (
+  _declaration: string,
+  macro: Macro,
+  diagnostics: Diagnostic[]
+): void => {
   let optionsPresent = _declaration.split('/')?.[1]?.trim()
 
   if (optionsPresent) {
@@ -108,6 +110,7 @@ const test = (value: string, config?: LintConfig) => {
 
     let result = regex.exec(optionsPresent)
 
+    // removing Option's `="..."` part, e.g. des="..."
     while (result) {
       optionsPresent =
         optionsPresent.slice(0, result.index) +
@@ -138,6 +141,17 @@ const test = (value: string, config?: LintConfig) => {
         }
       })
   }
+}
+
+const test = (value: string, config?: LintConfig) => {
+  const diagnostics: Diagnostic[] = []
+
+  const macros = parseMacros(value, config)
+
+  macros.forEach((macro) => {
+    const _declaration = processParams(value, macro, diagnostics)
+
+    processOptions(_declaration, macro, diagnostics)
   })
 
   return diagnostics

src/types/Macro.ts

@@ -0,0 +1,12 @@
+export interface Macro {
+  name: string
+  startLineNumbers: number[]
+  endLineNumber: number | null
+  declarationLines: string[]
+  terminationLine: string
+  declaration: string
+  termination: string
+  parentMacro: string
+  hasMacroNameInMend: boolean
+  mismatchedMendMacroName: string
+}

src/types/index.ts

@@ -4,3 +4,4 @@ export * from './LintConfig'
 export * from './LintRule'
 export * from './LintRuleType'
 export * from './Severity'
+export * from './Macro'

src/utils/parseMacros.ts

@@ -1,20 +1,7 @@
-import { LintConfig } from '../types/LintConfig'
+import { LintConfig, Macro } from '../types'
 import { LineEndings } from '../types/LineEndings'
 import { trimComments } from './trimComments'
 
-interface Macro {
-  name: string
-  startLineNumbers: number[]
-  endLineNumber: number | null
-  declarationLines: string[]
-  terminationLine: string
-  declaration: string
-  termination: string
-  parentMacro: string
-  hasMacroNameInMend: boolean
-  mismatchedMendMacroName: string
-}
-
 export const parseMacros = (text: string, config?: LintConfig): Macro[] => {
   const lineEnding = config?.lineEndings === LineEndings.CRLF ? '\r\n' : '\n'
   const lines: string[] = text ? text.split(lineEnding) : []
@@ -39,6 +26,8 @@ export const parseMacros = (text: string, config?: LintConfig): Macro[] => {
     const statements: string[] = trimmedLine.split(';')
 
     if (isReadingMacroDefinition) {
+      // checking if code is split into statements based on `;` is a part of HTML Encoded Character
+      // if it happened, merges two statements into one
       statements.forEach((statement, statementIndex) => {
         if (/&[^\s]{1,5}$/.test(statement)) {
           const next = statements[statementIndex]