@sasjs/lint 2.7.0 → 4.0.0

package/scripts/generate-macro-names.mjs

@@ -0,0 +1,101 @@
+/**
+ * Generates `src/utils/sasMacros.generated.ts` from the SAS language data.
+ *
+ * The list of macros that ship with SAS is not lint's to maintain: it is
+ * language data, and `@sasjs/sas-language` owns it. This script reads the
+ * `macroStatements` and `macroFunctions` groups and emits the names the
+ * `noUndeclaredMacros` rule treats as declared.
+ *
+ * The output is committed so that the published package carries no dependency
+ * on the data package, and `src/utils/sasMacros.spec.ts` regenerates the list
+ * from the same data and fails when the two differ, so a refresh upstream
+ * cannot leave the constant stale.
+ *
+ * Run with `npm run generate:macros`.
+ */
+import { readFile, writeFile } from 'node:fs/promises'
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+const ROOT = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..')
+const PACKAGE = '@sasjs/sas-language'
+const GROUPS = ['macroStatements', 'macroFunctions']
+const TARGET = path.join(ROOT, 'src', 'utils', 'sasMacros.generated.ts')
+
+const indexPath = (group) =>
+  path.join(
+    ROOT,
+    'node_modules',
+    ...PACKAGE.split('/'),
+    'data',
+    `${group}.index.json`
+  )
+
+/**
+ * Every macro name a group carries, as a bare lower-case name. Compound
+ * entries such as `%DO %UNTIL` are dropped: they are a spelling of the
+ * `%DO` statement and no source token can match them.
+ */
+const collectMacroNames = async () => {
+  const names = new Set()
+
+  for (const group of GROUPS) {
+    let parsed
+    try {
+      parsed = JSON.parse(await readFile(indexPath(group), 'utf8'))
+    } catch (error) {
+      throw new Error(
+        `cannot read ${PACKAGE}/data/${group}.index.json - run 'npm install' first (${error.message})`
+      )
+    }
+
+    if (!Array.isArray(parsed?.entries)) {
+      throw new Error(
+        `${PACKAGE}/data/${group}.index.json has an unexpected shape: expected { entries: [] }`
+      )
+    }
+
+    for (const entry of parsed.entries) {
+      const name = String(entry?.[0] ?? '')
+        .replace(/^%/, '')
+        .trim()
+        .toLowerCase()
+      if (!name || /\s/.test(name)) continue
+      names.add(name)
+    }
+  }
+
+  return [...names].sort()
+}
+
+/**
+ * The generated file's text.
+ */
+const render = (names) =>
+  [
+    '// Generated by scripts/generate-macro-names.mjs from @sasjs/sas-language.',
+    '// Do not edit. Regenerate with `npm run generate:macros`.',
+    '',
+    '/**',
+    ' * The macro names that ship with SAS, lower-cased and without the leading',
+    ' * `%`, as published in the macroStatements and macroFunctions groups of',
+    ' * `@sasjs/sas-language`.',
+    ' */',
+    'export const sasMacros: readonly string[] = [',
+    ...names.map((name) => `  '${name}',`),
+    ']',
+    ''
+  ].join('\n')
+
+const main = async () => {
+  const names = await collectMacroNames()
+  await writeFile(TARGET, render(names))
+  console.log(
+    `written: src/utils/sasMacros.generated.ts (${names.length} names)`
+  )
+}
+
+main().catch((error) => {
+  console.error(`generation failed: ${error.message}`)
+  process.exit(1)
+})

package/types/LintConfig.d.ts

@@ -9,6 +9,8 @@ import { Severity } from './Severity';
  * More types of rules, when available, will be added here.
  */
 export declare class LintConfig {
+    /** The JSON this configuration was built from, so it can be overridden. */
+    readonly source: any;
     readonly ignoreList: string[];
     readonly allowedGremlins: string[];
     readonly lineLintRules: LineLintRule[];
@@ -25,4 +27,15 @@ export declare class LintConfig {
     };
     readonly requiredMacroOptions: string[];
     constructor(json?: any);
+    /**
+     * Returns a new configuration with an override merged over this one, so a
+     * file can adjust the rules that apply to it.
+     *
+     * Scalars replace, arrays are additive and objects merge key by key - see
+     * `mergeLintConfig`.
+     *
+     * @param {object} json - the override, as read from a `@sasjslint` block.
+     * @returns {LintConfig} a new configuration; this one is unchanged.
+     */
+    override(json: any): LintConfig;
 }

package/types/LintConfig.js

@@ -6,6 +6,7 @@ const line_1 = require("../rules/line");
 const path_1 = require("../rules/path");
 const LineEndings_1 = require("./LineEndings");
 const utils_1 = require("../utils");
+const mergeLintConfig_1 = require("../utils/mergeLintConfig");
 const Severity_1 = require("./Severity");
 /**
  * LintConfig is the logical representation of the .sasjslint file.
@@ -29,6 +30,7 @@ class LintConfig {
         this.defaultHeader = (0, utils_1.getDefaultHeader)();
         this.severityLevel = {};
         this.requiredMacroOptions = [];
+        this.source = json !== null && json !== void 0 ? json : {};
         if (json === null || json === void 0 ? void 0 : json.ignoreList) {
             if (Array.isArray(json.ignoreList)) {
                 json.ignoreList.forEach((item) => {
@@ -52,9 +54,13 @@ class LintConfig {
         if ((json === null || json === void 0 ? void 0 : json.noTabs) === false || (json === null || json === void 0 ? void 0 : json.noTabIndentation) === false) {
             this.lineLintRules.pop();
         }
-        if ((json === null || json === void 0 ? void 0 : json.maxLineLength) > 0) {
+        // An absent setting falls back to the default, so the rule is on unless the
+        // value switches it off (0 or a negative number).
+        if ((json === null || json === void 0 ? void 0 : json.maxLineLength) === undefined || (json === null || json === void 0 ? void 0 : json.maxLineLength) > 0) {
             this.lineLintRules.push(line_1.maxLineLength);
-            this.maxLineLength = json.maxLineLength;
+            if (!isNaN(json === null || json === void 0 ? void 0 : json.maxLineLength)) {
+                this.maxLineLength = json.maxLineLength;
+            }
             if (!isNaN(json === null || json === void 0 ? void 0 : json.maxHeaderLineLength)) {
                 this.maxHeaderLineLength = json.maxHeaderLineLength;
             }
@@ -86,7 +92,7 @@ class LintConfig {
         if ((json === null || json === void 0 ? void 0 : json.lowerCaseFileNames) !== false) {
             this.pathLintRules.push(path_1.lowerCaseFileNames);
         }
-        if (json === null || json === void 0 ? void 0 : json.hasMacroNameInMend) {
+        if ((json === null || json === void 0 ? void 0 : json.hasMacroNameInMend) !== false) {
             this.fileLintRules.push(file_1.hasMacroNameInMend);
         }
         if ((json === null || json === void 0 ? void 0 : json.noNestedMacros) !== false) {
@@ -101,25 +107,28 @@ class LintConfig {
         if (json === null || json === void 0 ? void 0 : json.hasRequiredMacroOptions) {
             this.fileLintRules.push(file_1.hasRequiredMacroOptions);
             if (json === null || json === void 0 ? void 0 : json.requiredMacroOptions) {
-                if (Array.isArray(json.requiredMacroOptions) &&
-                    json.requiredMacroOptions.length > 0) {
-                    json.requiredMacroOptions.forEach((item) => {
-                        if (typeof item === 'string') {
-                            this.requiredMacroOptions.push(item);
-                        }
-                        else {
-                            throw new Error(`Property "requiredMacroOptions" has invalid type of values. It can only contain strings.`);
-                        }
-                    });
-                }
-                else {
+                if (!Array.isArray(json.requiredMacroOptions)) {
                     throw new Error(`Property "requiredMacroOptions" can only be an array of strings.`);
                 }
+                json.requiredMacroOptions.forEach((item) => {
+                    if (typeof item === 'string') {
+                        this.requiredMacroOptions.push(item);
+                    }
+                    else {
+                        throw new Error(`Property "requiredMacroOptions" has invalid type of values. It can only contain strings.`);
+                    }
+                });
             }
         }
         if (json === null || json === void 0 ? void 0 : json.noSingleAsteriskComments) {
             this.fileLintRules.push(file_1.noSingleAsteriskComments);
         }
+        if ((json === null || json === void 0 ? void 0 : json.noUndeclaredMacros) !== false) {
+            this.fileLintRules.push(file_1.noUndeclaredMacros);
+        }
+        if ((json === null || json === void 0 ? void 0 : json.noUnusedMacros) !== false) {
+            this.fileLintRules.push(file_1.noUnusedMacros);
+        }
         if ((json === null || json === void 0 ? void 0 : json.noGremlins) !== false) {
             this.lineLintRules.push(line_1.noGremlins);
             if (json === null || json === void 0 ? void 0 : json.allowedGremlins) {
@@ -145,6 +154,19 @@ class LintConfig {
             }
         }
     }
+    /**
+     * Returns a new configuration with an override merged over this one, so a
+     * file can adjust the rules that apply to it.
+     *
+     * Scalars replace, arrays are additive and objects merge key by key - see
+     * `mergeLintConfig`.
+     *
+     * @param {object} json - the override, as read from a `@sasjslint` block.
+     * @returns {LintConfig} a new configuration; this one is unchanged.
+     */
+    override(json) {
+        return new LintConfig((0, mergeLintConfig_1.mergeLintConfig)(this.source, json));
+    }
 }
 exports.LintConfig = LintConfig;
 //# sourceMappingURL=LintConfig.js.map

package/types/LintConfig.js.map

@@ -1 +1 @@
-{"version":3,"file":"LintConfig.js","sourceRoot":"","sources":["../../src/types/LintConfig.ts"],"names":[],"mappings":";;;AAAA,wCASsB;AACtB,wCAOsB;AACtB,wCAAuE;AACvE,+CAA2C;AAE3C,oCAA2C;AAC3C,yCAAqC;AAErC;;;;;;GAMG;AACH,MAAa,UAAU;IAerB,YAAY,IAAU;QAdb,eAAU,GAAa,EAAE,CAAA;QACzB,oBAAe,GAAa,EAAE,CAAA;QAC9B,kBAAa,GAAmB,EAAE,CAAA;QAClC,kBAAa,GAAmB,EAAE,CAAA;QAClC,kBAAa,GAAmB,EAAE,CAAA;QAClC,kBAAa,GAAW,EAAE,CAAA;QAC1B,wBAAmB,GAAW,EAAE,CAAA;QAChC,sBAAiB,GAAW,EAAE,CAAA;QAC9B,wBAAmB,GAAW,CAAC,CAAA;QAC/B,gBAAW,GAAgB,yBAAW,CAAC,EAAE,CAAA;QACzC,kBAAa,GAAW,IAAA,wBAAgB,GAAE,CAAA;QAC1C,kBAAa,GAAgC,EAAE,CAAA;QAC/C,yBAAoB,GAAa,EAAE,CAAA;QAG1C,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,UAAU,EAAE,CAAC;YACrB,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;gBACnC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,IAAS,EAAE,EAAE;oBACpC,IAAI,OAAO,IAAI,KAAK,QAAQ;wBAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;;wBAEtD,MAAM,IAAI,KAAK,CACb,gFAAgF,CACjF,CAAA;gBACL,CAAC,CAAC,CAAA;YACJ,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAA;YAC1E,CAAC;QACH,CAAC;QAED,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,gBAAgB,MAAK,KAAK,EAAE,CAAC;YACrC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,uBAAgB,CAAC,CAAA;QAC3C,CAAC;QAED,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,kBAAkB,MAAK,KAAK,EAAE,CAAC;YACvC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,yBAAkB,CAAC,CAAA;QAC7C,CAAC;QAED,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,aAAM,CAAC,CAAA;QAC/B,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,MAAK,KAAK,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,gBAAgB,MAAK,KAAK,EAAE,CAAC;YAC/D,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAAA;QAC1B,CAAC;QAED,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,aAAa,IAAG,CAAC,EAAE,CAAC;YAC5B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,oBAAa,CAAC,CAAA;YACtC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAA;YAEvC,IAAI,CAAC,KAAK,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,mBAAmB,CAAC,EAAE,CAAC;gBACtC,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,mBAAmB,CAAA;YACrD,CAAC;YAED,IAAI,CAAC,KAAK,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,iBAAiB,CAAC,EAAE,CAAC;gBACpC,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAA;YACjD,CAAC;QACH,CAAC;QAED,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,WAAW,KAAI,IAAI,CAAC,WAAW,KAAK,yBAAW,CAAC,GAAG,EAAE,CAAC;YAC9D,IACE,IAAI,CAAC,WAAW,KAAK,yBAAW,CAAC,EAAE;gBACnC,IAAI,CAAC,WAAW,KAAK,yBAAW,CAAC,IAAI,EACrC,CAAC;gBACD,MAAM,IAAI,KAAK,CACb,yCAAyC,yBAAW,CAAC,EAAE,OAAO,yBAAW,CAAC,IAAI,EAAE,CACjF,CAAA;YACH,CAAC;YACD,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,kBAAW,CAAC,CAAA;YACpC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAA;QACrC,CAAC;QAED,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,0BAAmB,CAAC,CAAA;QAC5C,IAAI,CAAC,KAAK,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,mBAAmB,CAAC,EAAE,CAAC;YACtC,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,mBAA6B,CAAA;QAC/D,CAAC;QAED,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,gBAAgB,MAAK,KAAK,EAAE,CAAC;YACrC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,uBAAgB,CAAC,CAAA;QAC3C,CAAC;QAED,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,aAAa,EAAE,CAAC;YACxB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAA;QACzC,CAAC;QAED,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,mBAAmB,MAAK,KAAK,EAAE,CAAC;YACxC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,0BAAmB,CAAC,CAAA;QAC9C,CAAC;QAED,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,kBAAkB,MAAK,KAAK,EAAE,CAAC;YACvC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,yBAAkB,CAAC,CAAA;QAC7C,CAAC;QAED,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,kBAAkB,EAAE,CAAC;YAC7B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,yBAAkB,CAAC,CAAA;QAC7C,CAAC;QAED,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,cAAc,MAAK,KAAK,EAAE,CAAC;YACnC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,qBAAc,CAAC,CAAA;QACzC,CAAC;QAED,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,mBAAmB,MAAK,KAAK,EAAE,CAAC;YACxC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,0BAAmB,CAAC,CAAA;QAC9C,CAAC;QAED,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,qBAAqB,MAAK,KAAK,EAAE,CAAC;YAC1C,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,4BAAqB,CAAC,CAAA;QAChD,CAAC;QAED,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,uBAAuB,EAAE,CAAC;YAClC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,8BAAuB,CAAC,CAAA;YAEhD,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,oBAAoB,EAAE,CAAC;gBAC/B,IACE,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,CAAC;oBACxC,IAAI,CAAC,oBAAoB,CAAC,MAAM,GAAG,CAAC,EACpC,CAAC;oBACD,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC,IAAS,EAAE,EAAE;wBAC9C,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;4BAC7B,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;wBACtC,CAAC;6BAAM,CAAC;4BACN,MAAM,IAAI,KAAK,CACb,0FAA0F,CAC3F,CAAA;wBACH,CAAC;oBACH,CAAC,CAAC,CAAA;gBACJ,CAAC;qBAAM,CAAC;oBACN,MAAM,IAAI,KAAK,CACb,kEAAkE,CACnE,CAAA;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,wBAAwB,EAAE,CAAC;YACnC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,+BAAwB,CAAC,CAAA;QACnD,CAAC;QAED,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,UAAU,MAAK,KAAK,EAAE,CAAC;YAC/B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,iBAAU,CAAC,CAAA;YAEnC,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,eAAe,EAAE,CAAC;gBAC1B,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;oBACxC,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,IAAS,EAAE,EAAE;wBACzC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC;4BAC3D,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;;4BAE/B,MAAM,IAAI,KAAK,CACb,gIAAgI,CACjI,CAAA;oBACL,CAAC,CAAC,CAAA;gBACJ,CAAC;qBAAM,CAAC;oBACN,MAAM,IAAI,KAAK,CACb,wGAAwG,CACzG,CAAA;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,aAAa,EAAE,CAAC;YACxB,KAAK,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC;gBAClE,IAAI,QAAQ,KAAK,MAAM;oBAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,mBAAQ,CAAC,OAAO,CAAA;gBACpE,IAAI,QAAQ,KAAK,OAAO;oBAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,mBAAQ,CAAC,KAAK,CAAA;YACrE,CAAC;QACH,CAAC;IACH,CAAC;CACF;AAnKD,gCAmKC"}
+{"version":3,"file":"LintConfig.js","sourceRoot":"","sources":["../../src/types/LintConfig.ts"],"names":[],"mappings":";;;AAAA,wCAWsB;AACtB,wCAOsB;AACtB,wCAAuE;AACvE,+CAA2C;AAE3C,oCAA2C;AAC3C,8DAA0D;AAC1D,yCAAqC;AAErC;;;;;;GAMG;AACH,MAAa,UAAU;IAiBrB,YAAY,IAAU;QAdb,eAAU,GAAa,EAAE,CAAA;QACzB,oBAAe,GAAa,EAAE,CAAA;QAC9B,kBAAa,GAAmB,EAAE,CAAA;QAClC,kBAAa,GAAmB,EAAE,CAAA;QAClC,kBAAa,GAAmB,EAAE,CAAA;QAClC,kBAAa,GAAW,EAAE,CAAA;QAC1B,wBAAmB,GAAW,EAAE,CAAA;QAChC,sBAAiB,GAAW,EAAE,CAAA;QAC9B,wBAAmB,GAAW,CAAC,CAAA;QAC/B,gBAAW,GAAgB,yBAAW,CAAC,EAAE,CAAA;QACzC,kBAAa,GAAW,IAAA,wBAAgB,GAAE,CAAA;QAC1C,kBAAa,GAAgC,EAAE,CAAA;QAC/C,yBAAoB,GAAa,EAAE,CAAA;QAG1C,IAAI,CAAC,MAAM,GAAG,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,CAAA;QAExB,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,UAAU,EAAE,CAAC;YACrB,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;gBACnC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,IAAS,EAAE,EAAE;oBACpC,IAAI,OAAO,IAAI,KAAK,QAAQ;wBAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;;wBAEtD,MAAM,IAAI,KAAK,CACb,gFAAgF,CACjF,CAAA;gBACL,CAAC,CAAC,CAAA;YACJ,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAA;YAC1E,CAAC;QACH,CAAC;QAED,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,gBAAgB,MAAK,KAAK,EAAE,CAAC;YACrC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,uBAAgB,CAAC,CAAA;QAC3C,CAAC;QAED,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,kBAAkB,MAAK,KAAK,EAAE,CAAC;YACvC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,yBAAkB,CAAC,CAAA;QAC7C,CAAC;QAED,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,aAAM,CAAC,CAAA;QAC/B,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,MAAK,KAAK,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,gBAAgB,MAAK,KAAK,EAAE,CAAC;YAC/D,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAAA;QAC1B,CAAC;QAED,4EAA4E;QAC5E,kDAAkD;QAClD,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,aAAa,MAAK,SAAS,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,aAAa,IAAG,CAAC,EAAE,CAAC;YACjE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,oBAAa,CAAC,CAAA;YAEtC,IAAI,CAAC,KAAK,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,aAAa,CAAC,EAAE,CAAC;gBAChC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAA;YACzC,CAAC;YAED,IAAI,CAAC,KAAK,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,mBAAmB,CAAC,EAAE,CAAC;gBACtC,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,mBAAmB,CAAA;YACrD,CAAC;YAED,IAAI,CAAC,KAAK,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,iBAAiB,CAAC,EAAE,CAAC;gBACpC,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAA;YACjD,CAAC;QACH,CAAC;QAED,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,WAAW,KAAI,IAAI,CAAC,WAAW,KAAK,yBAAW,CAAC,GAAG,EAAE,CAAC;YAC9D,IACE,IAAI,CAAC,WAAW,KAAK,yBAAW,CAAC,EAAE;gBACnC,IAAI,CAAC,WAAW,KAAK,yBAAW,CAAC,IAAI,EACrC,CAAC;gBACD,MAAM,IAAI,KAAK,CACb,yCAAyC,yBAAW,CAAC,EAAE,OAAO,yBAAW,CAAC,IAAI,EAAE,CACjF,CAAA;YACH,CAAC;YACD,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,kBAAW,CAAC,CAAA;YACpC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAA;QACrC,CAAC;QAED,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,0BAAmB,CAAC,CAAA;QAC5C,IAAI,CAAC,KAAK,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,mBAAmB,CAAC,EAAE,CAAC;YACtC,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,mBAA6B,CAAA;QAC/D,CAAC;QAED,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,gBAAgB,MAAK,KAAK,EAAE,CAAC;YACrC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,uBAAgB,CAAC,CAAA;QAC3C,CAAC;QAED,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,aAAa,EAAE,CAAC;YACxB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAA;QACzC,CAAC;QAED,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,mBAAmB,MAAK,KAAK,EAAE,CAAC;YACxC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,0BAAmB,CAAC,CAAA;QAC9C,CAAC;QAED,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,kBAAkB,MAAK,KAAK,EAAE,CAAC;YACvC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,yBAAkB,CAAC,CAAA;QAC7C,CAAC;QAED,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,kBAAkB,MAAK,KAAK,EAAE,CAAC;YACvC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,yBAAkB,CAAC,CAAA;QAC7C,CAAC;QAED,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,cAAc,MAAK,KAAK,EAAE,CAAC;YACnC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,qBAAc,CAAC,CAAA;QACzC,CAAC;QAED,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,mBAAmB,MAAK,KAAK,EAAE,CAAC;YACxC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,0BAAmB,CAAC,CAAA;QAC9C,CAAC;QAED,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,qBAAqB,MAAK,KAAK,EAAE,CAAC;YAC1C,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,4BAAqB,CAAC,CAAA;QAChD,CAAC;QAED,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,uBAAuB,EAAE,CAAC;YAClC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,8BAAuB,CAAC,CAAA;YAEhD,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,oBAAoB,EAAE,CAAC;gBAC/B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,CAAC,EAAE,CAAC;oBAC9C,MAAM,IAAI,KAAK,CACb,kEAAkE,CACnE,CAAA;gBACH,CAAC;gBAED,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC,IAAS,EAAE,EAAE;oBAC9C,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;wBAC7B,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;oBACtC,CAAC;yBAAM,CAAC;wBACN,MAAM,IAAI,KAAK,CACb,0FAA0F,CAC3F,CAAA;oBACH,CAAC;gBACH,CAAC,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;QAED,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,wBAAwB,EAAE,CAAC;YACnC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,+BAAwB,CAAC,CAAA;QACnD,CAAC;QAED,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,kBAAkB,MAAK,KAAK,EAAE,CAAC;YACvC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,yBAAkB,CAAC,CAAA;QAC7C,CAAC;QAED,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,cAAc,MAAK,KAAK,EAAE,CAAC;YACnC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,qBAAc,CAAC,CAAA;QACzC,CAAC;QAED,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,UAAU,MAAK,KAAK,EAAE,CAAC;YAC/B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,iBAAU,CAAC,CAAA;YAEnC,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,eAAe,EAAE,CAAC;gBAC1B,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;oBACxC,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,IAAS,EAAE,EAAE;wBACzC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC;4BAC3D,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;;4BAE/B,MAAM,IAAI,KAAK,CACb,gIAAgI,CACjI,CAAA;oBACL,CAAC,CAAC,CAAA;gBACJ,CAAC;qBAAM,CAAC;oBACN,MAAM,IAAI,KAAK,CACb,wGAAwG,CACzG,CAAA;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,aAAa,EAAE,CAAC;YACxB,KAAK,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC;gBAClE,IAAI,QAAQ,KAAK,MAAM;oBAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,mBAAQ,CAAC,OAAO,CAAA;gBACpE,IAAI,QAAQ,KAAK,OAAO;oBAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,mBAAQ,CAAC,KAAK,CAAA;YACrE,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,IAAS;QAChB,OAAO,IAAI,UAAU,CAAC,IAAA,iCAAe,EAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAA;IAC3D,CAAC;CACF;AA/LD,gCA+LC"}

package/utils/getLintConfig.d.ts

@@ -2,26 +2,39 @@ import { LintConfig } from '../types/LintConfig';
 import { LineEndings } from '../types/LineEndings';
 export declare const getDefaultHeader: () => string;
 /**
- * Default configuration that is used when a .sasjslint file is not found
+ * Default configuration that is used when a .sasjslint file is not found.
+ *
+ * It lists every setting the linter reads, with its default value, so it
+ * doubles as the reference for the `.sasjslint` file. `getLintConfig.spec.ts`
+ * enumerates the settings the config reads and fails if this object misses one,
+ * and the README mirrors it.
  */
 export declare const DefaultLintConfiguration: {
-    lineEndings: LineEndings;
-    noTrailingSpaces: boolean;
-    noEncodedPasswords: boolean;
+    allowedGremlins: never[];
+    defaultHeader: string;
     hasDoxygenHeader: boolean;
-    noSpacesInFileNames: boolean;
+    hasMacroNameInMend: boolean;
+    hasMacroParentheses: boolean;
+    hasRequiredMacroOptions: boolean;
+    ignoreList: never[];
+    indentationMultiple: number;
+    lineEndings: LineEndings;
     lowerCaseFileNames: boolean;
-    maxLineLength: number;
-    maxHeaderLineLength: number;
     maxDataLineLength: number;
-    noTabIndentation: boolean;
-    indentationMultiple: number;
-    hasMacroNameInMend: boolean;
+    maxHeaderLineLength: number;
+    maxLineLength: number;
+    noEncodedPasswords: boolean;
+    noGremlins: boolean;
     noNestedMacros: boolean;
-    hasMacroParentheses: boolean;
+    noSingleAsteriskComments: boolean;
+    noSpacesInFileNames: boolean;
+    noTabs: boolean;
+    noTrailingSpaces: boolean;
+    noUndeclaredMacros: boolean;
+    noUnusedMacros: boolean;
+    requiredMacroOptions: never[];
+    severityLevel: {};
     strictMacroDefinition: boolean;
-    noGremlins: boolean;
-    defaultHeader: string;
 };
 /**
  * Fetches the config from the .sasjslint file (at project root or home directory) and creates a LintConfig object.

package/utils/getLintConfig.js

@@ -20,29 +20,42 @@ const LintConfig_1 = require("../types/LintConfig");
 const file_1 = require("@sasjs/utils/file");
 const getProjectRoot_1 = require("./getProjectRoot");
 const LineEndings_1 = require("../types/LineEndings");
-const getDefaultHeader = () => `/**{lineEnding}  @file{lineEnding}  @brief <Your brief here>{lineEnding}  <h4> SAS Macros </h4>{lineEnding}**/`;
+const getDefaultHeader = () => `/**{lineEnding}  @file{lineEnding}  @brief <Your brief here>{lineEnding}{lineEnding}  <h4> SAS Macros </h4>{lineEnding}{lineEnding}**/`;
 exports.getDefaultHeader = getDefaultHeader;
 /**
- * Default configuration that is used when a .sasjslint file is not found
+ * Default configuration that is used when a .sasjslint file is not found.
+ *
+ * It lists every setting the linter reads, with its default value, so it
+ * doubles as the reference for the `.sasjslint` file. `getLintConfig.spec.ts`
+ * enumerates the settings the config reads and fails if this object misses one,
+ * and the README mirrors it.
  */
 exports.DefaultLintConfiguration = {
-    lineEndings: LineEndings_1.LineEndings.OFF,
-    noTrailingSpaces: true,
-    noEncodedPasswords: true,
+    allowedGremlins: [],
+    defaultHeader: (0, exports.getDefaultHeader)(),
     hasDoxygenHeader: true,
-    noSpacesInFileNames: true,
-    lowerCaseFileNames: true,
-    maxLineLength: 80,
-    maxHeaderLineLength: 80,
-    maxDataLineLength: 80,
-    noTabIndentation: true,
-    indentationMultiple: 2,
     hasMacroNameInMend: true,
-    noNestedMacros: true,
     hasMacroParentheses: true,
-    strictMacroDefinition: true,
+    hasRequiredMacroOptions: false,
+    ignoreList: [],
+    indentationMultiple: 2,
+    lineEndings: LineEndings_1.LineEndings.OFF,
+    lowerCaseFileNames: true,
+    maxDataLineLength: 80,
+    maxHeaderLineLength: 80,
+    maxLineLength: 80,
+    noEncodedPasswords: true,
     noGremlins: true,
-    defaultHeader: (0, exports.getDefaultHeader)()
+    noNestedMacros: true,
+    noSingleAsteriskComments: false,
+    noSpacesInFileNames: true,
+    noTabs: true,
+    noTrailingSpaces: true,
+    noUndeclaredMacros: true,
+    noUnusedMacros: true,
+    requiredMacroOptions: [],
+    severityLevel: {},
+    strictMacroDefinition: true
 };
 /**
  * Fetches the config from the .sasjslint file (at project root or home directory) and creates a LintConfig object.

package/utils/getLintConfig.js.map

@@ -1 +1 @@
-{"version":3,"file":"getLintConfig.js","sourceRoot":"","sources":["../../src/utils/getLintConfig.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAsCA,sCASC;AA/CD,gDAAuB;AACvB,4CAAmB;AACnB,oDAAgD;AAChD,4CAA4C;AAC5C,qDAAiD;AACjD,sDAAkD;AAE3C,MAAM,gBAAgB,GAAG,GAAG,EAAE,CACnC,gHAAgH,CAAA;AADrG,QAAA,gBAAgB,oBACqF;AAElH;;GAEG;AACU,QAAA,wBAAwB,GAAG;IACtC,WAAW,EAAE,yBAAW,CAAC,GAAG;IAC5B,gBAAgB,EAAE,IAAI;IACtB,kBAAkB,EAAE,IAAI;IACxB,gBAAgB,EAAE,IAAI;IACtB,mBAAmB,EAAE,IAAI;IACzB,kBAAkB,EAAE,IAAI;IACxB,aAAa,EAAE,EAAE;IACjB,mBAAmB,EAAE,EAAE;IACvB,iBAAiB,EAAE,EAAE;IACrB,gBAAgB,EAAE,IAAI;IACtB,mBAAmB,EAAE,CAAC;IACtB,kBAAkB,EAAE,IAAI;IACxB,cAAc,EAAE,IAAI;IACpB,mBAAmB,EAAE,IAAI;IACzB,qBAAqB,EAAE,IAAI;IAC3B,UAAU,EAAE,IAAI;IAChB,aAAa,EAAE,IAAA,wBAAgB,GAAE;CAClC,CAAA;AAED;;;;GAIG;AACH,SAAsB,aAAa;;QACjC,MAAM,WAAW,GAAG,MAAM,IAAA,+BAAc,GAAE,CAAA;QAC1C,MAAM,gBAAgB,GAAG,WAAW,IAAI,YAAE,CAAC,OAAO,EAAE,CAAA;QACpD,MAAM,aAAa,GAAG,MAAM,IAAA,eAAQ,EAClC,cAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,YAAY,CAAC,CAC1C,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;YACZ,OAAO,IAAI,CAAC,SAAS,CAAC,gCAAwB,CAAC,CAAA;QACjD,CAAC,CAAC,CAAA;QACF,OAAO,IAAI,uBAAU,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAA;IAClD,CAAC;CAAA"}
+{"version":3,"file":"getLintConfig.js","sourceRoot":"","sources":["../../src/utils/getLintConfig.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAmDA,sCASC;AA5DD,gDAAuB;AACvB,4CAAmB;AACnB,oDAAgD;AAChD,4CAA4C;AAC5C,qDAAiD;AACjD,sDAAkD;AAE3C,MAAM,gBAAgB,GAAG,GAAG,EAAE,CACnC,wIAAwI,CAAA;AAD7H,QAAA,gBAAgB,oBAC6G;AAE1I;;;;;;;GAOG;AACU,QAAA,wBAAwB,GAAG;IACtC,eAAe,EAAE,EAAE;IACnB,aAAa,EAAE,IAAA,wBAAgB,GAAE;IACjC,gBAAgB,EAAE,IAAI;IACtB,kBAAkB,EAAE,IAAI;IACxB,mBAAmB,EAAE,IAAI;IACzB,uBAAuB,EAAE,KAAK;IAC9B,UAAU,EAAE,EAAE;IACd,mBAAmB,EAAE,CAAC;IACtB,WAAW,EAAE,yBAAW,CAAC,GAAG;IAC5B,kBAAkB,EAAE,IAAI;IACxB,iBAAiB,EAAE,EAAE;IACrB,mBAAmB,EAAE,EAAE;IACvB,aAAa,EAAE,EAAE;IACjB,kBAAkB,EAAE,IAAI;IACxB,UAAU,EAAE,IAAI;IAChB,cAAc,EAAE,IAAI;IACpB,wBAAwB,EAAE,KAAK;IAC/B,mBAAmB,EAAE,IAAI;IACzB,MAAM,EAAE,IAAI;IACZ,gBAAgB,EAAE,IAAI;IACtB,kBAAkB,EAAE,IAAI;IACxB,cAAc,EAAE,IAAI;IACpB,oBAAoB,EAAE,EAAE;IACxB,aAAa,EAAE,EAAE;IACjB,qBAAqB,EAAE,IAAI;CAC5B,CAAA;AAED;;;;GAIG;AACH,SAAsB,aAAa;;QACjC,MAAM,WAAW,GAAG,MAAM,IAAA,+BAAc,GAAE,CAAA;QAC1C,MAAM,gBAAgB,GAAG,WAAW,IAAI,YAAE,CAAC,OAAO,EAAE,CAAA;QACpD,MAAM,aAAa,GAAG,MAAM,IAAA,eAAQ,EAClC,cAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,YAAY,CAAC,CAC1C,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;YACZ,OAAO,IAAI,CAAC,SAAS,CAAC,gCAAwB,CAAC,CAAA;QACjD,CAAC,CAAC,CAAA;QACF,OAAO,IAAI,uBAAU,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAA;IAClD,CAAC;CAAA"}

package/utils/headerMacros.d.ts

@@ -0,0 +1,51 @@
+import { LintConfig } from '../types';
+/**
+ * A macro that is declared in the header of a file, along with the position of
+ * its `@li` entry.
+ */
+export interface HeaderMacro {
+    name: string;
+    lineNumber: number;
+    startColumnNumber: number;
+    endColumnNumber: number;
+    section: 'sasMacros' | 'otherMacros';
+}
+/**
+ * Reads the macros declared in the header of a file - both the
+ * `<h4> SAS Macros </h4>` and the `<h4> Other Macros </h4>` sections.
+ * @param {string} text - the text content of the file.
+ * @param {LintConfig} config - the lint configuration, used for line endings.
+ * @returns {HeaderMacro[]} the declared macros, in the order they appear.
+ */
+export declare const getHeaderMacros: (text: string, config?: LintConfig) => HeaderMacro[];
+/**
+ * Adds macro names to the `<h4> SAS Macros </h4>` section of a file header,
+ * merging them with the entries that are already listed, de-duplicating by
+ * name, and sorting the result alphabetically. A new section is added when the
+ * header has none.
+ *
+ * A blank line separates the section from the header content before it and from
+ * whatever follows the list, so the section reads as its own block.
+ *
+ * @param {string} text - the text content of the file.
+ * @param {LintConfig} config - the lint configuration, used for line endings.
+ * @param {string[]} macros - the macro names to add.
+ * @returns {string} the updated text content.
+ */
+export declare const addMacrosToHeader: (text: string, config: LintConfig, macros: string[]) => string;
+/**
+ * Removes macro names from the `<h4> SAS Macros </h4>` section of a file
+ * header. The section header itself is kept, so an empty list remains a valid
+ * place for the formatter to add entries. The blank line before the section and
+ * after the list is preserved.
+ *
+ * The file is returned unchanged when it has no Doxygen header, when the header
+ * has no `SAS Macros` section, when the section cannot be rewritten safely, or
+ * when none of the named macros are listed.
+ *
+ * @param {string} text - the text content of the file.
+ * @param {LintConfig} config - the lint configuration, used for line endings.
+ * @param {string[]} macros - the macro names to remove.
+ * @returns {string} the updated text content.
+ */
+export declare const removeMacrosFromHeader: (text: string, config: LintConfig, macros: string[]) => string;