Merge pull request #179 from sasjs/issue-178

feat: customise the defaultHeader

README.md

@@ -33,12 +33,33 @@ Configuration is via a `.sasjslint` file with the following structure (these are
     "noNestedMacros": true,
     "noSpacesInFileNames": true,
     "noTabIndentation": true,
-    "noTrailingSpaces": true
+    "noTrailingSpaces": true,
+    "defaultHeader": "/**{lineEnding}  @file{lineEnding}  @brief <Your brief here>{lineEnding}  <h4> SAS Macros </h4>{lineEnding}**/"
 }
 ```
 
 ### SAS Lint Settings
 
+#### defaultHeader
+
+This sets the default program header - applies when a SAS program does NOT begin with `/**`.  The default header is as follows:
+
+```sas
+/**
+  @file
+  @brief <Your brief here>
+  <h4> SAS Macros </h4>
+**/
+```
+
+The default header is automatically applied when running `sasjs lint fix` in the SASjs CLI, or by hitting "save" when using the SASjs VS Code extension.  If creating a new value, use `{lineEnding}` instead of `\n`, eg as follows:
+
+```json
+{
+  "defaultHeader": "/**{lineEnding}  @file{lineEnding}  @brief Our Company Brief{lineEnding}**/"
+}
+```
+
 #### noEncodedPasswords
 
 This will highlight any rows that contain a `{sas00X}` type password, or `{sasenc}`.  These passwords (especially 001 and 002) are NOT secure, and should NEVER be pushed to source control or saved to the filesystem without special permissions applied.

src/format/shared.ts

@@ -19,7 +19,7 @@ const processContent = (config: LintConfig, content: string): string => {
   config.fileLintRules
     .filter((r) => !!r.fix)
     .forEach((rule) => {
-      processedContent = rule.fix!(processedContent)
+      processedContent = rule.fix!(processedContent, config)
     })
 
   return processedContent

src/rules/file/hasDoxygenHeader.ts

@@ -3,8 +3,7 @@ import { LineEndings } from '../../types/LineEndings'
 import { FileLintRule } from '../../types/LintRule'
 import { LintRuleType } from '../../types/LintRuleType'
 import { Severity } from '../../types/Severity'
-
+import { DefaultLintConfiguration } from '../../utils/getLintConfig'
-const DoxygenHeader = `/**{lineEnding}  @file{lineEnding}  @brief <Your brief here>{lineEnding}  <h4> SAS Macros </h4>{lineEnding}**/`
 
 const name = 'hasDoxygenHeader'
 const description =
@@ -61,10 +60,11 @@ const fix = (value: string, config?: LintConfig): string => {
   } else if (result[0].message == messageForSingleAsterisk)
     return value.replace('/*', '/**')
 
+  config = config || new LintConfig(DefaultLintConfiguration)
   const lineEndingConfig = config?.lineEndings || LineEndings.LF
   const lineEnding = lineEndingConfig === LineEndings.LF ? '\n' : '\r\n'
 
-  return `${DoxygenHeader.replace(
+  return `${config?.defaultHeader.replace(
     /{lineEnding}/g,
     lineEnding
   )}${lineEnding}${value}`

src/types/LintConfig.ts

@@ -16,6 +16,7 @@ import {
 import { lowerCaseFileNames, noSpacesInFileNames } from '../rules/path'
 import { LineEndings } from './LineEndings'
 import { FileLintRule, LineLintRule, PathLintRule } from './LintRule'
+import { getDefaultHeader } from '../utils'
 
 /**
  * LintConfig is the logical representation of the .sasjslint file.
@@ -32,6 +33,7 @@ export class LintConfig {
   readonly maxLineLength: number = 80
   readonly indentationMultiple: number = 2
   readonly lineEndings: LineEndings = LineEndings.LF
+  readonly defaultHeader: string = getDefaultHeader()
 
   constructor(json?: any) {
     if (json?.ignoreList) {
@@ -87,6 +89,10 @@ export class LintConfig {
       this.fileLintRules.push(hasDoxygenHeader)
     }
 
+    if (json?.defaultHeader) {
+      this.defaultHeader = json.defaultHeader
+    }
+
     if (json?.noSpacesInFileNames) {
       this.pathLintRules.push(noSpacesInFileNames)
     }

src/utils/getLintConfig.ts

@@ -3,6 +3,9 @@ import { LintConfig } from '../types/LintConfig'
 import { readFile } from '@sasjs/utils/file'
 import { getProjectRoot } from './getProjectRoot'
 
+export const getDefaultHeader = () =>
+  `/**{lineEnding}  @file{lineEnding}  @brief <Your brief here>{lineEnding}  <h4> SAS Macros </h4>{lineEnding}**/`
+
 /**
  * Default configuration that is used when a .sasjslint file is not found
  */
@@ -18,7 +21,8 @@ export const DefaultLintConfiguration = {
   hasMacroNameInMend: true,
   noNestedMacros: true,
   hasMacroParentheses: true,
-  strictMacroDefinition: true
+  strictMacroDefinition: true,
+  defaultHeader: getDefaultHeader()
 }
 
 /**