Merge pull request #180 from sasjs/quick-fix

feat: add configuration as an optional argument for formatText

.gitpod.yml

@@ -0,0 +1,8 @@
+# This configuration file was automatically generated by Gitpod.
+# Please adjust to your needs (see https://www.gitpod.io/docs/config-gitpod-file)
+# and commit this file to your remote git repository to share the goodness with others.
+
+tasks:
+  - init: npm install && npm run build
+
+

README.md

@@ -23,18 +23,43 @@ Configuration is via a `.sasjslint` file with the following structure (these are
     "hasDoxygenHeader": true,
     "hasMacroNameInMend": true,
     "hasMacroParentheses": true,
+    "ignoreList": [
+      "sajsbuild/",
+      "sasjsresults/"
+    ],
     "indentationMultiple": 2,
     "lowerCaseFileNames": true,
     "maxLineLength": 80,
     "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.
@@ -60,6 +85,9 @@ As per the example [here](https://github.com/sasjs/lint/issues/20), macros defin
 * Default:  true
 * Severity: WARNING
 
+#### ignoreList
+There may be specific files (or folders) that are not good candidates for linting.  Simply list them in this array and they will be ignored.  In addition, any files in the project `.gitignore` file will also be ignored.
+
 #### indentationMultiple
 This will check each line to ensure that the count of leading spaces can be divided cleanly by this multiple.
 
@@ -75,7 +103,7 @@ On *nix systems, it is imperative that autocall macros are in lowercase.  When s
 #### maxLineLength
 Code becomes far more readable when line lengths are short.  The most compelling reason for short line lengths is to avoid the need to scroll when performing a side-by-side 'compare' between two files (eg as part of a GIT feature branch review).  A longer discussion on optimal code line length can be found [here](https://stackoverflow.com/questions/578059/studies-on-optimal-code-width)
 
-In batch mode, long SAS code lines may also be truncated, causing hard-to-detect errors.  
+In batch mode, long SAS code lines may also be truncated, causing hard-to-detect errors.
 
 We strongly recommend a line length limit, and set the bar at 80.  To turn this feature off, set the value to 0.
 
@@ -83,7 +111,7 @@ We strongly recommend a line length limit, and set the bar at 80.  To turn this
 * Severity: WARNING
 
 #### noNestedMacros
-Where macros are defined inside other macros, they are recompiled every time the outer macro is invoked.  Hence, it is widely considered inefficient, and bad practice, to nest macro definitions.  
+Where macros are defined inside other macros, they are recompiled every time the outer macro is invoked.  Hence, it is widely considered inefficient, and bad practice, to nest macro definitions.
 
 * Default:  true
 * Severity: WARNING
@@ -113,7 +141,7 @@ This will highlight lines with trailing spaces.  Trailing spaces serve no useful
 
 ### Upcoming Linting Rules:
 
-* `noTabs` -> does what it says on the tin 
+* `noTabs` -> does what it says on the tin
 * `noGremlins` -> identifies all invisible characters, other than spaces / tabs / line endings.  If you really need that bell character, use a hex literal!
 * `lineEndings` -> set a standard line ending, such as LF or CRLF
 
@@ -123,13 +151,13 @@ A formatter will automatically apply rules when you hit SAVE, which can save a L
 
 We've already implemented the following rules:
 
-* Add the macro name to the %mend statement 
+* Add the macro name to the %mend statement
-* Add a doxygen header template if none exists 
+* Add a doxygen header template if none exists
 * Remove trailing spaces
 
 We're looking to implement the following rules:
 
-* Change tabs to spaces 
+* Change tabs to spaces
 * zap gremlins
 * fix line endings
 

sasjslint-schema.json

@@ -7,6 +7,7 @@
   "default": {
     "noEncodedPasswords": true,
     "hasDoxygenHeader": true,
+    "defaultHeader": "/**{lineEnding}  @file{lineEnding}  @brief <Your brief here>{lineEnding}  <h4> SAS Macros </h4>{lineEnding}**/",
     "hasMacroNameInMend": false,
     "hasMacroParentheses": true,
     "indentationMultiple": 2,
@@ -17,7 +18,8 @@
     "noTabIndentation": true,
     "noTrailingSpaces": true,
     "lineEndings": "lf",
-    "strictMacroDefinition": true
+    "strictMacroDefinition": true,
+    "ignoreList": ["sajsbuild", "sasjsresults"]
   },
   "examples": [
     {
@@ -33,7 +35,8 @@
       "noNestedMacros": true,
       "hasMacroParentheses": true,
       "lineEndings": "crlf",
-      "strictMacroDefinition": true
+      "strictMacroDefinition": true,
+      "ignoreList": ["sajsbuild", "sasjsresults"]
     }
   ],
   "properties": {
@@ -53,6 +56,14 @@
       "default": true,
       "examples": [true, false]
     },
+    "defaultHeader": {
+      "$id": "#/properties/defaultHeader",
+      "type": "boolean",
+      "title": "defaultHeader",
+      "description": "This sets the default program header - applies when a SAS program does NOT begin with `/**`.",
+      "default": "/**{lineEnding}  @file{lineEnding}  @brief <Your brief here>{lineEnding}  <h4> SAS Macros </h4>{lineEnding}**/",
+      "examples": []
+    },
     "hasMacroNameInMend": {
       "$id": "#/properties/hasMacroNameInMend",
       "type": "boolean",
@@ -143,11 +154,11 @@
     },
     "ignoreList": {
       "$id": "#/properties/ignoreList",
-      "type": "object",
+      "type": "array",
       "title": "ignoreList",
-      "description": "An array of paths or path patterns to ignore matching resources from linting. Files or folders matching patterns in .gitignore will always be ignored.",
+      "description": "An array of paths or path patterns to ignore when linting. Any files or matching patterns in the .gitignore file will also be ignored.",
       "default": ["sasjsbuild/", "sasjsresults/"],
-      "examples": ["sasjs/services", "appinit.sas"]
+      "examples": ["sasjs/tests", "tmp/scratch.sas"]
     }
   }
 }

src/format/formatText.ts

@@ -1,7 +1,8 @@
+import { LintConfig } from '../types'
 import { getLintConfig } from '../utils'
 import { processText } from './shared'
 
-export const formatText = async (text: string) => {
+export const formatText = async (text: string, configuration?: LintConfig) => {
-  const config = await getLintConfig()
+  const config = configuration || (await getLintConfig())
   return processText(text, config)
 }

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
@@ -30,7 +30,7 @@ export const processLine = (config: LintConfig, line: string): string => {
   config.lineLintRules
     .filter((r) => !!r.fix)
     .forEach((rule) => {
-      processedLine = rule.fix!(line)
+      processedLine = rule.fix!(line, config)
     })
 
   return processedLine

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()
 }
 
 /**