feat: add a new config maxHeaderLineLength

src/utils/getHeaderLinesCount.spec.ts

@@ -0,0 +1,21 @@
+import { LintConfig } from '../types'
+import { getHeaderLinesCount } from './getHeaderLinesCount'
+import { DefaultLintConfiguration } from './getLintConfig'
+
+const sasCodeWithHeader = `/**
+@file
+@brief <Your brief here>
+<h4> SAS Macros </h4>
+**/
+%put hello world;
+`
+
+const sasCodeWithoutHeader = `%put hello world;`
+
+describe('getHeaderLinesCount', () => {
+  it('should return the number of line header spans upon', () => {
+    const config = new LintConfig(DefaultLintConfiguration)
+    expect(getHeaderLinesCount(sasCodeWithHeader, config)).toEqual(5)
+    expect(getHeaderLinesCount(sasCodeWithoutHeader, config)).toEqual(0)
+  })
+})

src/utils/getHeaderLinesCount.ts

@@ -0,0 +1,25 @@
+import { LintConfig } from '../types'
+import { splitText } from './splitText'
+
+/**
+ * This funtion returns the number of lines header spans upon.
+ */
+export const getHeaderLinesCount = (text: string, config: LintConfig) => {
+  text = text.replace('/*', '/**')
+  text = text.replace('*/', '**/')
+
+  let count = 0
+
+  if (text.trimStart().startsWith('/**')) {
+    const lines = splitText(text, config)
+
+    for (const line of lines) {
+      count++
+      if (line.match(/\*\*\//)) {
+        break
+      }
+    }
+  }
+
+  return count
+}

src/utils/getLintConfig.ts

@@ -16,6 +16,7 @@ export const DefaultLintConfiguration = {
   noSpacesInFileNames: true,
   lowerCaseFileNames: true,
   maxLineLength: 80,
+  maxHeaderLineLength: 80,
   noTabIndentation: true,
   indentationMultiple: 2,
   hasMacroNameInMend: true,

src/utils/index.ts

@@ -6,3 +6,4 @@ export * from './isIgnored'
 export * from './listSasFiles'
 export * from './splitText'
 export * from './getIndicesOf'
+export * from './getHeaderLinesCount'