@sasjs/lint 2.7.0 → 4.0.0

package/README.md

@@ -17,16 +17,17 @@ Our goal is to help SAS developers everywhere spend less time on code reviews, b
 - [@sasjs/vscode-extension](https://github.com/sasjs/vscode-extension) - just download SASjs in the VSCode marketplace, and select view/problems in the menu bar.
 - [@sasjs/cli](https://cli.sasjs.io/lint) - run `sasjs lint` to get a list of all files with their problems, along with line and column indexes.
 
-Configuration is via a `.sasjslint` file with the following structure (these are also the defaults if no .sasjslint file is found):
+Configuration is via a `.sasjslint` file with the following structure (these are also the defaults - a setting that is absent, and a project with no `.sasjslint` file at all, uses the value below):
 
 ```json
 {
+  "allowedGremlins": [],
+  "defaultHeader": "/**{lineEnding}  @file{lineEnding}  @brief <Your brief here>{lineEnding}{lineEnding}  <h4> SAS Macros </h4>{lineEnding}{lineEnding}**/",
   "hasDoxygenHeader": true,
   "hasMacroNameInMend": true,
   "hasMacroParentheses": true,
   "hasRequiredMacroOptions": false,
-  "requiredMacroOptions": ["SECURE", "SRC"],
-  "ignoreList": ["sasjsbuild/", "sasjsresults/"],
+  "ignoreList": [],
   "indentationMultiple": 2,
   "lineEndings": "off",
   "lowerCaseFileNames": true,
@@ -34,13 +35,17 @@ Configuration is via a `.sasjslint` file with the following structure (these are
   "maxHeaderLineLength": 80,
   "maxLineLength": 80,
   "noEncodedPasswords": true,
+  "noGremlins": true,
   "noNestedMacros": true,
   "noSingleAsteriskComments": false,
-  "noGremlins": true,
   "noSpacesInFileNames": true,
   "noTabs": true,
   "noTrailingSpaces": true,
-  "defaultHeader": "/**{lineEnding}  @file{lineEnding}  @brief <Your brief here>{lineEnding}  <h4> SAS Macros </h4>{lineEnding}**/"
+  "noUndeclaredMacros": true,
+  "noUnusedMacros": true,
+  "requiredMacroOptions": [],
+  "severityLevel": {},
+  "strictMacroDefinition": true
 }
 ```
 
@@ -56,6 +61,29 @@ For more details, and the default state, see the description of each rule below.
 
 Configuring a non-zero return code (ERROR) is helpful when running `sasjs lint` as part of a git pre-commit hook.  An example is available [here](https://github.com/sasjs/template_jobs/blob/main/.git-hooks/pre-commit).
 
+## Per-file overrides
+
+A file can adjust the configuration for itself, with a `@sasjslint` block in its Doxygen header:
+
+```sas
+/**
+  @file
+  @brief Calls the settlement API
+
+  @sasjslint {"maxHeaderLineLength": 200, "noUndeclaredMacros": false}
+**/
+```
+
+The block holds a JSON object that is merged over the resolved `.sasjslint`:
+
+- scalars replace, so a file can switch a rule off, switch one on, or raise a limit for itself;
+- arrays are additive, so `allowedGremlins` and `requiredMacroOptions` gain entries rather than replacing the project's;
+- objects merge key by key, so a file can set one `severityLevel` without dropping the others.
+
+The override applies to the whole file, and to the formatter, so `sasjs lint fix` and format-on-save honour it - a file that switches `noUnusedMacros` off keeps the entries it would otherwise lose. Only the header is read, so an override cannot be hidden in the body of a file, and a block that is malformed is ignored rather than raised. Place it outside the `<h4> SAS Macros </h4>` section, which the formatter rewrites.
+
+One exception: `ignoreList` is evaluated before a file is read, so an entry a header adds cannot exclude the file it sits in.
+
 ### allowedGremlins
 
 An array of hex codes that represents allowed gremlins (invisible / undesirable characters). To allow all gremlins, you can also set the `noGremlins` rule to `false`.  The full gremlin list is [here](https://github.com/sasjs/lint/blob/main/src/utils/gremlinCharacters.ts).
@@ -79,10 +107,14 @@ The default header is as follows:
 /**
   @file
   @brief <Your brief here>
+
   <h4> SAS Macros </h4>
+
 **/
 ```
 
+A blank line separates the `<h4> SAS Macros </h4>` section from the header content before it and from whatever follows the list. The same blank-line convention applies to the `<h4> Other Macros </h4>` section.
+
 If creating a new value, use `{lineEnding}` instead of `\n`, eg as follows:
 
 ```json
@@ -289,6 +321,27 @@ This will highlight lines with trailing spaces. Trailing spaces serve no useful
 - Default: true
 - severity: WARNING
 
+### noUndeclaredMacros
+
+SASjs programs declare the macros they use in the `<h4> SAS Macros </h4>` section of the header, so that the compiler can assemble the job before it runs. This rule reports a warning for each macro that a file invokes without declaring it - either by defining it in the file, or by listing it under `<h4> SAS Macros </h4>` or `<h4> Other Macros </h4>`.
+
+The macros that ship with SAS (`%scan`, `%index`, `%sysfunc` and the other macro functions, along with the macro language keywords such as `%if`, `%then` and `%do`) are always considered declared, so they are never reported. That list is generated from the `macroStatements` and `macroFunctions` groups of `@sasjs/sas-language` (`npm run generate:macros`), so it tracks the SAS language data rather than being maintained here. Macros made available through the `SASAUTOS` system option are not visible to the linter and will be reported.
+
+The warning is resolved by adding the macro name to the header. Running `sasjs lint fix` (or saving in the SASjs VS Code extension with `formatOnSave`) adds the missing macros automatically, as a unique list sorted alphabetically.
+
+- Default: true
+- Severity: WARNING
+
+### noUnusedMacros
+
+The counterpart of `noUndeclaredMacros`. This rule reports a warning for each macro listed under `<h4> SAS Macros </h4>` that the file itself never invokes, which usually means the header is out of date.
+
+A macro can be referenced indirectly - for example by another macro in the dependency chain, or through a dynamic `%&macro` call - without appearing as a direct invocation in the file, so the warning is advisory.
+
+Running `sasjs lint fix` (or saving in the SASjs VS Code extension with `formatOnSave`) removes the unused entries from the header. Together with `noUndeclaredMacros`, this leaves the `<h4> SAS Macros </h4>` section listing exactly the macros the file uses.
+
+- Default: true
+- Severity: WARNING
 
 ## severityLevel
 
@@ -318,6 +371,8 @@ We've already implemented the following rules:
 
 - Add the macro name to the %mend statement
 - Add a doxygen header template if none exists
+- Add undeclared macros to the `<h4> SAS Macros </h4>` section
+- Remove unused macros from the `<h4> SAS Macros </h4>` section
 - Remove trailing spaces
 
 We're looking to implement the following rules:

package/format/formatFile.js

@@ -12,6 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.formatFile = void 0;
 const file_1 = require("@sasjs/utils/file");
 const lint_1 = require("../lint");
+const parseLintOverride_1 = require("../utils/parseLintOverride");
 const getLintConfig_1 = require("../utils/getLintConfig");
 const shared_1 = require("./shared");
 /**
@@ -25,7 +26,7 @@ const formatFile = (filePath, configuration) => __awaiter(void 0, void 0, void 0
     const diagnosticsBeforeFormat = yield (0, lint_1.lintFile)(filePath, config);
     const diagnosticsCountBeforeFormat = diagnosticsBeforeFormat.length;
     const text = yield (0, file_1.readFile)(filePath);
-    const formattedText = (0, shared_1.processText)(text, config);
+    const formattedText = (0, shared_1.processText)(text, (0, parseLintOverride_1.applyLintOverride)(text, config));
     yield (0, file_1.createFile)(filePath, formattedText);
     const diagnosticsAfterFormat = yield (0, lint_1.lintFile)(filePath, config);
     const diagnosticsCountAfterFormat = diagnosticsAfterFormat.length;

package/format/formatFile.js.map

@@ -1 +1 @@
-{"version":3,"file":"formatFile.js","sourceRoot":"","sources":["../../src/format/formatFile.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4CAAwD;AACxD,kCAAkC;AAGlC,0DAAsD;AACtD,qCAAsC;AAEtC;;;;;GAKG;AACI,MAAM,UAAU,GAAG,CACxB,QAAgB,EAChB,aAA0B,EACH,EAAE;IACzB,MAAM,MAAM,GAAG,aAAa,IAAI,CAAC,MAAM,IAAA,6BAAa,GAAE,CAAC,CAAA;IACvD,MAAM,uBAAuB,GAAG,MAAM,IAAA,eAAQ,EAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;IAChE,MAAM,4BAA4B,GAAG,uBAAuB,CAAC,MAAM,CAAA;IAEnE,MAAM,IAAI,GAAG,MAAM,IAAA,eAAQ,EAAC,QAAQ,CAAC,CAAA;IAErC,MAAM,aAAa,GAAG,IAAA,oBAAW,EAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IAE/C,MAAM,IAAA,iBAAU,EAAC,QAAQ,EAAE,aAAa,CAAC,CAAA;IAEzC,MAAM,sBAAsB,GAAG,MAAM,IAAA,eAAQ,EAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;IAC/D,MAAM,2BAA2B,GAAG,sBAAsB,CAAC,MAAM,CAAA;IAEjE,MAAM,qBAAqB,GACzB,4BAA4B,GAAG,2BAA2B,CAAA;IAE5D,MAAM,gBAAgB,GAAa,EAAE,CAAA;IAErC,IAAI,qBAAqB,EAAE,CAAC;QAC1B,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;IACjC,CAAC;IAED,OAAO;QACL,gBAAgB;QAChB,qBAAqB;QACrB,kBAAkB,EAAE,sBAAsB;KAC3C,CAAA;AACH,CAAC,CAAA,CAAA;AA/BY,QAAA,UAAU,cA+BtB"}
+{"version":3,"file":"formatFile.js","sourceRoot":"","sources":["../../src/format/formatFile.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4CAAwD;AACxD,kCAAkC;AAGlC,kEAA8D;AAC9D,0DAAsD;AACtD,qCAAsC;AAEtC;;;;;GAKG;AACI,MAAM,UAAU,GAAG,CACxB,QAAgB,EAChB,aAA0B,EACH,EAAE;IACzB,MAAM,MAAM,GAAG,aAAa,IAAI,CAAC,MAAM,IAAA,6BAAa,GAAE,CAAC,CAAA;IACvD,MAAM,uBAAuB,GAAG,MAAM,IAAA,eAAQ,EAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;IAChE,MAAM,4BAA4B,GAAG,uBAAuB,CAAC,MAAM,CAAA;IAEnE,MAAM,IAAI,GAAG,MAAM,IAAA,eAAQ,EAAC,QAAQ,CAAC,CAAA;IAErC,MAAM,aAAa,GAAG,IAAA,oBAAW,EAAC,IAAI,EAAE,IAAA,qCAAiB,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAA;IAExE,MAAM,IAAA,iBAAU,EAAC,QAAQ,EAAE,aAAa,CAAC,CAAA;IAEzC,MAAM,sBAAsB,GAAG,MAAM,IAAA,eAAQ,EAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;IAC/D,MAAM,2BAA2B,GAAG,sBAAsB,CAAC,MAAM,CAAA;IAEjE,MAAM,qBAAqB,GACzB,4BAA4B,GAAG,2BAA2B,CAAA;IAE5D,MAAM,gBAAgB,GAAa,EAAE,CAAA;IAErC,IAAI,qBAAqB,EAAE,CAAC;QAC1B,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;IACjC,CAAC;IAED,OAAO;QACL,gBAAgB;QAChB,qBAAqB;QACrB,kBAAkB,EAAE,sBAAsB;KAC3C,CAAA;AACH,CAAC,CAAA,CAAA;AA/BY,QAAA,UAAU,cA+BtB"}

package/format/formatText.js

@@ -14,7 +14,7 @@ const utils_1 = require("../utils");
 const shared_1 = require("./shared");
 const formatText = (text, configuration) => __awaiter(void 0, void 0, void 0, function* () {
     const config = configuration || (yield (0, utils_1.getLintConfig)());
-    return (0, shared_1.processText)(text, config);
+    return (0, shared_1.processText)(text, (0, utils_1.applyLintOverride)(text, config));
 });
 exports.formatText = formatText;
 //# sourceMappingURL=formatText.js.map

package/format/formatText.js.map

@@ -1 +1 @@
-{"version":3,"file":"formatText.js","sourceRoot":"","sources":["../../src/format/formatText.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,oCAAwC;AACxC,qCAAsC;AAE/B,MAAM,UAAU,GAAG,CAAO,IAAY,EAAE,aAA0B,EAAE,EAAE;IAC3E,MAAM,MAAM,GAAG,aAAa,IAAI,CAAC,MAAM,IAAA,qBAAa,GAAE,CAAC,CAAA;IACvD,OAAO,IAAA,oBAAW,EAAC,IAAI,EAAE,MAAM,CAAC,CAAA;AAClC,CAAC,CAAA,CAAA;AAHY,QAAA,UAAU,cAGtB"}
+{"version":3,"file":"formatText.js","sourceRoot":"","sources":["../../src/format/formatText.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,oCAA2D;AAC3D,qCAAsC;AAE/B,MAAM,UAAU,GAAG,CAAO,IAAY,EAAE,aAA0B,EAAE,EAAE;IAC3E,MAAM,MAAM,GAAG,aAAa,IAAI,CAAC,MAAM,IAAA,qBAAa,GAAE,CAAC,CAAA;IACvD,OAAO,IAAA,oBAAW,EAAC,IAAI,EAAE,IAAA,yBAAiB,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAA;AAC3D,CAAC,CAAA,CAAA;AAHY,QAAA,UAAU,cAGtB"}

package/lint/lintFile.js

@@ -24,8 +24,9 @@ const lintFile = (filePath, configuration) => __awaiter(void 0, void 0, void 0,
         return [];
     const config = configuration || (yield (0, utils_1.getLintConfig)());
     const text = yield (0, file_1.readFile)(filePath);
-    const fileDiagnostics = (0, shared_1.processFile)(filePath, config);
-    const textDiagnostics = (0, shared_1.processText)(text, config);
+    const effectiveConfig = (0, utils_1.applyLintOverride)(text, config);
+    const fileDiagnostics = (0, shared_1.processFile)(filePath, effectiveConfig);
+    const textDiagnostics = (0, shared_1.processText)(text, effectiveConfig);
     return [...fileDiagnostics, ...textDiagnostics];
 });
 exports.lintFile = lintFile;

package/lint/lintFile.js.map

@@ -1 +1 @@
-{"version":3,"file":"lintFile.js","sourceRoot":"","sources":["../../src/lint/lintFile.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4CAA4C;AAE5C,oCAAmD;AACnD,qCAAmD;AAEnD;;;;;GAKG;AACI,MAAM,QAAQ,GAAG,CACtB,QAAgB,EAChB,aAA0B,EACH,EAAE;IACzB,IAAI,MAAM,IAAA,iBAAS,EAAC,QAAQ,EAAE,aAAa,CAAC;QAAE,OAAO,EAAE,CAAA;IAEvD,MAAM,MAAM,GAAG,aAAa,IAAI,CAAC,MAAM,IAAA,qBAAa,GAAE,CAAC,CAAA;IACvD,MAAM,IAAI,GAAG,MAAM,IAAA,eAAQ,EAAC,QAAQ,CAAC,CAAA;IAErC,MAAM,eAAe,GAAG,IAAA,oBAAW,EAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;IACrD,MAAM,eAAe,GAAG,IAAA,oBAAW,EAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IAEjD,OAAO,CAAC,GAAG,eAAe,EAAE,GAAG,eAAe,CAAC,CAAA;AACjD,CAAC,CAAA,CAAA;AAbY,QAAA,QAAQ,YAapB"}
+{"version":3,"file":"lintFile.js","sourceRoot":"","sources":["../../src/lint/lintFile.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4CAA4C;AAE5C,oCAAsE;AACtE,qCAAmD;AAEnD;;;;;GAKG;AACI,MAAM,QAAQ,GAAG,CACtB,QAAgB,EAChB,aAA0B,EACH,EAAE;IACzB,IAAI,MAAM,IAAA,iBAAS,EAAC,QAAQ,EAAE,aAAa,CAAC;QAAE,OAAO,EAAE,CAAA;IAEvD,MAAM,MAAM,GAAG,aAAa,IAAI,CAAC,MAAM,IAAA,qBAAa,GAAE,CAAC,CAAA;IACvD,MAAM,IAAI,GAAG,MAAM,IAAA,eAAQ,EAAC,QAAQ,CAAC,CAAA;IACrC,MAAM,eAAe,GAAG,IAAA,yBAAiB,EAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IAEvD,MAAM,eAAe,GAAG,IAAA,oBAAW,EAAC,QAAQ,EAAE,eAAe,CAAC,CAAA;IAC9D,MAAM,eAAe,GAAG,IAAA,oBAAW,EAAC,IAAI,EAAE,eAAe,CAAC,CAAA;IAE1D,OAAO,CAAC,GAAG,eAAe,EAAE,GAAG,eAAe,CAAC,CAAA;AACjD,CAAC,CAAA,CAAA;AAdY,QAAA,QAAQ,YAcpB"}

package/lint/lintText.js

@@ -22,7 +22,7 @@ const shared_1 = require("./shared");
  */
 const lintText = (text, configuration) => __awaiter(void 0, void 0, void 0, function* () {
     const config = configuration || (yield (0, utils_1.getLintConfig)());
-    return (0, shared_1.processText)(text, config);
+    return (0, shared_1.processText)(text, (0, utils_1.applyLintOverride)(text, config));
 });
 exports.lintText = lintText;
 //# sourceMappingURL=lintText.js.map

package/lint/lintText.js.map

@@ -1 +1 @@
-{"version":3,"file":"lintText.js","sourceRoot":"","sources":["../../src/lint/lintText.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,oCAAwC;AACxC,qCAAsC;AAEtC;;;;;;;GAOG;AACI,MAAM,QAAQ,GAAG,CACtB,IAAY,EACZ,aAA0B,EACH,EAAE;IACzB,MAAM,MAAM,GAAG,aAAa,IAAI,CAAC,MAAM,IAAA,qBAAa,GAAE,CAAC,CAAA;IACvD,OAAO,IAAA,oBAAW,EAAC,IAAI,EAAE,MAAM,CAAC,CAAA;AAClC,CAAC,CAAA,CAAA;AANY,QAAA,QAAQ,YAMpB"}
+{"version":3,"file":"lintText.js","sourceRoot":"","sources":["../../src/lint/lintText.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,oCAA2D;AAC3D,qCAAsC;AAEtC;;;;;;;GAOG;AACI,MAAM,QAAQ,GAAG,CACtB,IAAY,EACZ,aAA0B,EACH,EAAE;IACzB,MAAM,MAAM,GAAG,aAAa,IAAI,CAAC,MAAM,IAAA,qBAAa,GAAE,CAAC,CAAA;IACvD,OAAO,IAAA,oBAAW,EAAC,IAAI,EAAE,IAAA,yBAAiB,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAA;AAC3D,CAAC,CAAA,CAAA;AANY,QAAA,QAAQ,YAMpB"}

package/package.json

@@ -4,6 +4,7 @@
   "scripts": {
     "test": "jest --coverage",
     "build": "rimraf build && tsc",
+    "generate:macros": "node ./scripts/generate-macro-names.mjs",
     "preinstall": "node checkNodeVersion",
     "prebuild": "node checkNodeVersion",
     "publishInit": "cp -r ./build/* . && rm -rf ./build && rm -rf ./src && rm tsconfig.json",
@@ -59,6 +60,7 @@
   "homepage": "https://github.com/sasjs/lint#readme",
   "devDependencies": {
     "@nogoo9/gitleaks": "8.30.1-post.2",
+    "@sasjs/sas-language": "0.3.0",
     "@types/jest": "30.0.0",
     "@types/node": "26.6.3",
     "jest": "30.5.2",
@@ -70,5 +72,5 @@
     "@sasjs/utils": "3.6.2",
     "ignore": "7.0.11"
   },
-  "version": "2.7.0"
+  "version": "4.0.0"
 }

package/rules/file/index.d.ts

@@ -3,6 +3,8 @@ export { hasMacroNameInMend } from './hasMacroNameInMend';
 export { hasMacroParentheses } from './hasMacroParentheses';
 export { lineEndings } from './lineEndings';
 export { noNestedMacros } from './noNestedMacros';
+export { noUndeclaredMacros } from './noUndeclaredMacros';
+export { noUnusedMacros } from './noUnusedMacros';
 export { strictMacroDefinition } from './strictMacroDefinition';
 export { hasRequiredMacroOptions } from './hasRequiredMacroOptions';
 export { noSingleAsteriskComments } from './noSingleAsteriskComments';

package/rules/file/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.noSingleAsteriskComments = exports.hasRequiredMacroOptions = exports.strictMacroDefinition = exports.noNestedMacros = exports.lineEndings = exports.hasMacroParentheses = exports.hasMacroNameInMend = exports.hasDoxygenHeader = void 0;
+exports.noSingleAsteriskComments = exports.hasRequiredMacroOptions = exports.strictMacroDefinition = exports.noUnusedMacros = exports.noUndeclaredMacros = exports.noNestedMacros = exports.lineEndings = exports.hasMacroParentheses = exports.hasMacroNameInMend = exports.hasDoxygenHeader = void 0;
 var hasDoxygenHeader_1 = require("./hasDoxygenHeader");
 Object.defineProperty(exports, "hasDoxygenHeader", { enumerable: true, get: function () { return hasDoxygenHeader_1.hasDoxygenHeader; } });
 var hasMacroNameInMend_1 = require("./hasMacroNameInMend");
@@ -11,6 +11,10 @@ var lineEndings_1 = require("./lineEndings");
 Object.defineProperty(exports, "lineEndings", { enumerable: true, get: function () { return lineEndings_1.lineEndings; } });
 var noNestedMacros_1 = require("./noNestedMacros");
 Object.defineProperty(exports, "noNestedMacros", { enumerable: true, get: function () { return noNestedMacros_1.noNestedMacros; } });
+var noUndeclaredMacros_1 = require("./noUndeclaredMacros");
+Object.defineProperty(exports, "noUndeclaredMacros", { enumerable: true, get: function () { return noUndeclaredMacros_1.noUndeclaredMacros; } });
+var noUnusedMacros_1 = require("./noUnusedMacros");
+Object.defineProperty(exports, "noUnusedMacros", { enumerable: true, get: function () { return noUnusedMacros_1.noUnusedMacros; } });
 var strictMacroDefinition_1 = require("./strictMacroDefinition");
 Object.defineProperty(exports, "strictMacroDefinition", { enumerable: true, get: function () { return strictMacroDefinition_1.strictMacroDefinition; } });
 var hasRequiredMacroOptions_1 = require("./hasRequiredMacroOptions");

package/rules/file/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/rules/file/index.ts"],"names":[],"mappings":";;;AAAA,uDAAqD;AAA5C,oHAAA,gBAAgB,OAAA;AACzB,2DAAyD;AAAhD,wHAAA,kBAAkB,OAAA;AAC3B,6DAA2D;AAAlD,0HAAA,mBAAmB,OAAA;AAC5B,6CAA2C;AAAlC,0GAAA,WAAW,OAAA;AACpB,mDAAiD;AAAxC,gHAAA,cAAc,OAAA;AACvB,iEAA+D;AAAtD,8HAAA,qBAAqB,OAAA;AAC9B,qEAAmE;AAA1D,kIAAA,uBAAuB,OAAA;AAChC,uEAAqE;AAA5D,oIAAA,wBAAwB,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/rules/file/index.ts"],"names":[],"mappings":";;;AAAA,uDAAqD;AAA5C,oHAAA,gBAAgB,OAAA;AACzB,2DAAyD;AAAhD,wHAAA,kBAAkB,OAAA;AAC3B,6DAA2D;AAAlD,0HAAA,mBAAmB,OAAA;AAC5B,6CAA2C;AAAlC,0GAAA,WAAW,OAAA;AACpB,mDAAiD;AAAxC,gHAAA,cAAc,OAAA;AACvB,2DAAyD;AAAhD,wHAAA,kBAAkB,OAAA;AAC3B,mDAAiD;AAAxC,gHAAA,cAAc,OAAA;AACvB,iEAA+D;AAAtD,8HAAA,qBAAqB,OAAA;AAC9B,qEAAmE;AAA1D,kIAAA,uBAAuB,OAAA;AAChC,uEAAqE;AAA5D,oIAAA,wBAAwB,OAAA"}

package/rules/file/noUndeclaredMacros.d.ts

@@ -0,0 +1,7 @@
+import { FileLintRule } from '../../types/LintRule';
+/**
+ * Lint rule that reports each macro a file uses without declaring it in the
+ * header. The formatter resolves the warning by adding the macro names to the
+ * `<h4> SAS Macros </h4>` section.
+ */
+export declare const noUndeclaredMacros: FileLintRule;

package/rules/file/noUndeclaredMacros.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.noUndeclaredMacros = void 0;
+const types_1 = require("../../types");
+const LintRuleType_1 = require("../../types/LintRuleType");
+const Severity_1 = require("../../types/Severity");
+const headerMacros_1 = require("../../utils/headerMacros");
+const parseMacroCalls_1 = require("../../utils/parseMacroCalls");
+const parseMacros_1 = require("../../utils/parseMacros");
+const sasMacros_1 = require("../../utils/sasMacros");
+const name = 'noUndeclaredMacros';
+const description = 'Enforce that every macro used in a file is declared.';
+const message = `Macro '{macro}' is not declared - add it to the <h4> SAS Macros </h4> or <h4> Other Macros </h4> section of the header`;
+/**
+ * Collects the first invocation of each macro that the file uses but does not
+ * declare. A macro is declared when it is defined in the file, or listed in the
+ * `<h4> SAS Macros </h4>` or `<h4> Other Macros </h4>` section of its header.
+ * Macros that ship with SAS are always considered declared.
+ */
+const getUndeclaredCalls = (value, config) => {
+    if (!value)
+        return [];
+    const declared = new Set();
+    (0, parseMacros_1.parseMacros)(value, config).forEach((macro) => {
+        if (macro.name)
+            declared.add(macro.name.toLowerCase());
+    });
+    (0, headerMacros_1.getHeaderMacros)(value, config).forEach((macro) => {
+        declared.add(macro.name.toLowerCase());
+    });
+    const undeclared = [];
+    const seen = new Set();
+    (0, parseMacroCalls_1.parseMacroCalls)(value, config).forEach((call) => {
+        const key = call.name.toLowerCase();
+        if (seen.has(key))
+            return;
+        seen.add(key);
+        if ((0, sasMacros_1.isSasMacro)(call.name))
+            return;
+        if (declared.has(key))
+            return;
+        undeclared.push(call);
+    });
+    return undeclared;
+};
+const test = (value, config) => {
+    const cfg = config || new types_1.LintConfig();
+    const severity = cfg.severityLevel[name] || Severity_1.Severity.Warning;
+    return getUndeclaredCalls(value, cfg).map((call) => ({
+        message: message.replace('{macro}', call.name),
+        lineNumber: call.lineNumber,
+        startColumnNumber: call.startColumnNumber,
+        endColumnNumber: call.endColumnNumber,
+        severity
+    }));
+};
+const fix = (value, config) => {
+    const cfg = config || new types_1.LintConfig();
+    const macros = getUndeclaredCalls(value, cfg).map((call) => call.name);
+    if (!macros.length)
+        return value;
+    return (0, headerMacros_1.addMacrosToHeader)(value, cfg, macros);
+};
+/**
+ * Lint rule that reports each macro a file uses without declaring it in the
+ * header. The formatter resolves the warning by adding the macro names to the
+ * `<h4> SAS Macros </h4>` section.
+ */
+exports.noUndeclaredMacros = {
+    type: LintRuleType_1.LintRuleType.File,
+    name,
+    description,
+    message,
+    test,
+    fix
+};
+//# sourceMappingURL=noUndeclaredMacros.js.map

package/rules/file/noUndeclaredMacros.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"noUndeclaredMacros.js","sourceRoot":"","sources":["../../../src/rules/file/noUndeclaredMacros.ts"],"names":[],"mappings":";;;AAAA,uCAAoD;AAEpD,2DAAuD;AACvD,mDAA+C;AAC/C,2DAA6E;AAC7E,iEAAwE;AACxE,yDAAqD;AACrD,qDAAkD;AAElD,MAAM,IAAI,GAAG,oBAAoB,CAAA;AACjC,MAAM,WAAW,GAAG,sDAAsD,CAAA;AAC1E,MAAM,OAAO,GAAG,wHAAwH,CAAA;AAExI;;;;;GAKG;AACH,MAAM,kBAAkB,GAAG,CAAC,KAAa,EAAE,MAAkB,EAAe,EAAE;IAC5E,IAAI,CAAC,KAAK;QAAE,OAAO,EAAE,CAAA;IAErB,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAA;IAElC,IAAA,yBAAW,EAAC,KAAK,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QAC3C,IAAI,KAAK,CAAC,IAAI;YAAE,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAA;IACxD,CAAC,CAAC,CAAA;IAEF,IAAA,8BAAe,EAAC,KAAK,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QAC/C,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAA;IACxC,CAAC,CAAC,CAAA;IAEF,MAAM,UAAU,GAAgB,EAAE,CAAA;IAClC,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAA;IAE9B,IAAA,iCAAe,EAAC,KAAK,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QAC9C,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAA;QACnC,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,OAAM;QACzB,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAEb,IAAI,IAAA,sBAAU,EAAC,IAAI,CAAC,IAAI,CAAC;YAAE,OAAM;QACjC,IAAI,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,OAAM;QAE7B,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACvB,CAAC,CAAC,CAAA;IAEF,OAAO,UAAU,CAAA;AACnB,CAAC,CAAA;AAED,MAAM,IAAI,GAAG,CAAC,KAAa,EAAE,MAAmB,EAAgB,EAAE;IAChE,MAAM,GAAG,GAAG,MAAM,IAAI,IAAI,kBAAU,EAAE,CAAA;IACtC,MAAM,QAAQ,GAAG,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,mBAAQ,CAAC,OAAO,CAAA;IAE5D,OAAO,kBAAkB,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACnD,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC;QAC9C,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,iBAAiB,EAAE,IAAI,CAAC,iBAAiB;QACzC,eAAe,EAAE,IAAI,CAAC,eAAe;QACrC,QAAQ;KACT,CAAC,CAAC,CAAA;AACL,CAAC,CAAA;AAED,MAAM,GAAG,GAAG,CAAC,KAAa,EAAE,MAAmB,EAAU,EAAE;IACzD,MAAM,GAAG,GAAG,MAAM,IAAI,IAAI,kBAAU,EAAE,CAAA;IACtC,MAAM,MAAM,GAAG,kBAAkB,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAEtE,IAAI,CAAC,MAAM,CAAC,MAAM;QAAE,OAAO,KAAK,CAAA;IAEhC,OAAO,IAAA,gCAAiB,EAAC,KAAK,EAAE,GAAG,EAAE,MAAM,CAAC,CAAA;AAC9C,CAAC,CAAA;AAED;;;;GAIG;AACU,QAAA,kBAAkB,GAAiB;IAC9C,IAAI,EAAE,2BAAY,CAAC,IAAI;IACvB,IAAI;IACJ,WAAW;IACX,OAAO;IACP,IAAI;IACJ,GAAG;CACJ,CAAA"}

package/rules/file/noUnusedMacros.d.ts

@@ -0,0 +1,7 @@
+import { FileLintRule } from '../../types/LintRule';
+/**
+ * Lint rule that reports macros declared in the `<h4> SAS Macros </h4>` section
+ * of a file header that the file itself never invokes. The formatter removes
+ * them from the header.
+ */
+export declare const noUnusedMacros: FileLintRule;

package/rules/file/noUnusedMacros.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.noUnusedMacros = void 0;
+const types_1 = require("../../types");
+const LintRuleType_1 = require("../../types/LintRuleType");
+const Severity_1 = require("../../types/Severity");
+const headerMacros_1 = require("../../utils/headerMacros");
+const parseMacroCalls_1 = require("../../utils/parseMacroCalls");
+const name = 'noUnusedMacros';
+const description = 'Report macros declared in the <h4> SAS Macros </h4> section that the file does not use.';
+const message = `Macro '{macro}' is declared in the <h4> SAS Macros </h4> section but not used in the file`;
+/**
+ * Collects the macros declared in the `<h4> SAS Macros </h4>` section that the
+ * file itself never invokes. A macro that appears more than once is reported
+ * once, at its first entry.
+ */
+const getUnusedMacros = (value, config) => {
+    if (!value)
+        return [];
+    const used = new Set((0, parseMacroCalls_1.parseMacroCalls)(value, config).map((call) => call.name.toLowerCase()));
+    const unused = [];
+    const reported = new Set();
+    (0, headerMacros_1.getHeaderMacros)(value, config)
+        .filter((macro) => macro.section === 'sasMacros')
+        .forEach((macro) => {
+        const key = macro.name.toLowerCase();
+        if (reported.has(key))
+            return;
+        reported.add(key);
+        if (used.has(key))
+            return;
+        unused.push(macro);
+    });
+    return unused;
+};
+const test = (value, config) => {
+    const cfg = config || new types_1.LintConfig();
+    const severity = cfg.severityLevel[name] || Severity_1.Severity.Warning;
+    return getUnusedMacros(value, cfg).map((macro) => ({
+        message: message.replace('{macro}', macro.name),
+        lineNumber: macro.lineNumber,
+        startColumnNumber: macro.startColumnNumber,
+        endColumnNumber: macro.endColumnNumber,
+        severity
+    }));
+};
+const fix = (value, config) => {
+    const cfg = config || new types_1.LintConfig();
+    const macros = getUnusedMacros(value, cfg).map((macro) => macro.name);
+    if (!macros.length)
+        return value;
+    return (0, headerMacros_1.removeMacrosFromHeader)(value, cfg, macros);
+};
+/**
+ * Lint rule that reports macros declared in the `<h4> SAS Macros </h4>` section
+ * of a file header that the file itself never invokes. The formatter removes
+ * them from the header.
+ */
+exports.noUnusedMacros = {
+    type: LintRuleType_1.LintRuleType.File,
+    name,
+    description,
+    message,
+    test,
+    fix
+};
+//# sourceMappingURL=noUnusedMacros.js.map

package/rules/file/noUnusedMacros.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"noUnusedMacros.js","sourceRoot":"","sources":["../../../src/rules/file/noUnusedMacros.ts"],"names":[],"mappings":";;;AAAA,uCAAoD;AAEpD,2DAAuD;AACvD,mDAA+C;AAC/C,2DAIiC;AACjC,iEAA6D;AAE7D,MAAM,IAAI,GAAG,gBAAgB,CAAA;AAC7B,MAAM,WAAW,GACf,yFAAyF,CAAA;AAC3F,MAAM,OAAO,GAAG,2FAA2F,CAAA;AAE3G;;;;GAIG;AACH,MAAM,eAAe,GAAG,CAAC,KAAa,EAAE,MAAkB,EAAiB,EAAE;IAC3E,IAAI,CAAC,KAAK;QAAE,OAAO,EAAE,CAAA;IAErB,MAAM,IAAI,GAAG,IAAI,GAAG,CAClB,IAAA,iCAAe,EAAC,KAAK,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CACtE,CAAA;IAED,MAAM,MAAM,GAAkB,EAAE,CAAA;IAChC,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAA;IAElC,IAAA,8BAAe,EAAC,KAAK,EAAE,MAAM,CAAC;SAC3B,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,KAAK,WAAW,CAAC;SAChD,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QACjB,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,CAAA;QACpC,IAAI,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,OAAM;QAC7B,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QACjB,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,OAAM;QAEzB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACpB,CAAC,CAAC,CAAA;IAEJ,OAAO,MAAM,CAAA;AACf,CAAC,CAAA;AAED,MAAM,IAAI,GAAG,CAAC,KAAa,EAAE,MAAmB,EAAgB,EAAE;IAChE,MAAM,GAAG,GAAG,MAAM,IAAI,IAAI,kBAAU,EAAE,CAAA;IACtC,MAAM,QAAQ,GAAG,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,mBAAQ,CAAC,OAAO,CAAA;IAE5D,OAAO,eAAe,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACjD,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC;QAC/C,UAAU,EAAE,KAAK,CAAC,UAAU;QAC5B,iBAAiB,EAAE,KAAK,CAAC,iBAAiB;QAC1C,eAAe,EAAE,KAAK,CAAC,eAAe;QACtC,QAAQ;KACT,CAAC,CAAC,CAAA;AACL,CAAC,CAAA;AAED,MAAM,GAAG,GAAG,CAAC,KAAa,EAAE,MAAmB,EAAU,EAAE;IACzD,MAAM,GAAG,GAAG,MAAM,IAAI,IAAI,kBAAU,EAAE,CAAA;IACtC,MAAM,MAAM,GAAG,eAAe,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IAErE,IAAI,CAAC,MAAM,CAAC,MAAM;QAAE,OAAO,KAAK,CAAA;IAEhC,OAAO,IAAA,qCAAsB,EAAC,KAAK,EAAE,GAAG,EAAE,MAAM,CAAC,CAAA;AACnD,CAAC,CAAA;AAED;;;;GAIG;AACU,QAAA,cAAc,GAAiB;IAC1C,IAAI,EAAE,2BAAY,CAAC,IAAI;IACvB,IAAI;IACJ,WAAW;IACX,OAAO;IACP,IAAI;IACJ,GAAG;CACJ,CAAA"}

package/sasjslint-schema.json

@@ -3,29 +3,33 @@
   "$id": "https://github.com/sasjs/lint/blob/main/sasjslint-schema.json",
   "type": "object",
   "title": "SASjs Lint Config File",
-  "description": "The SASjs Lint Config file provides the settings for customising SAS code style in your project.",
+  "description": "The SASjs Lint Config file provides the settings for customising SAS code style in your project. A SAS file can override these settings for itself with a `@sasjslint` block in its Doxygen header.",
   "default": {
-    "noEncodedPasswords": true,
+    "allowedGremlins": [],
+    "defaultHeader": "/**{lineEnding}  @file{lineEnding}  @brief <Your brief here>{lineEnding}{lineEnding}  <h4> SAS Macros </h4>{lineEnding}{lineEnding}**/",
     "hasDoxygenHeader": true,
-    "defaultHeader": "/**{lineEnding}  @file{lineEnding}  @brief <Your brief here>{lineEnding}  <h4> SAS Macros </h4>{lineEnding}**/",
-    "hasMacroNameInMend": false,
+    "hasMacroNameInMend": true,
     "hasMacroParentheses": true,
+    "hasRequiredMacroOptions": false,
+    "ignoreList": [],
     "indentationMultiple": 2,
+    "lineEndings": "off",
     "lowerCaseFileNames": true,
-    "maxLineLength": 80,
-    "maxHeaderLineLength": 80,
     "maxDataLineLength": 80,
+    "maxHeaderLineLength": 80,
+    "maxLineLength": 80,
+    "noEncodedPasswords": true,
     "noGremlins": true,
     "noNestedMacros": true,
     "noSingleAsteriskComments": false,
     "noSpacesInFileNames": true,
     "noTabs": true,
     "noTrailingSpaces": true,
-    "lineEndings": "off",
-    "strictMacroDefinition": true,
-    "ignoreList": ["sajsbuild", "sasjsresults"],
-    "hasRequiredMacroOptions": false,
-    "requiredMacroOptions": []
+    "noUndeclaredMacros": true,
+    "noUnusedMacros": true,
+    "requiredMacroOptions": [],
+    "severityLevel": {},
+    "strictMacroDefinition": true
   },
   "examples": [
     {
@@ -44,6 +48,8 @@
       "hasMacroNameInMend": true,
       "noNestedMacros": true,
       "noSingleAsteriskComments": false,
+      "noUndeclaredMacros": true,
+      "noUnusedMacros": true,
       "hasMacroParentheses": true,
       "lineEndings": "crlf",
       "strictMacroDefinition": true,
@@ -74,7 +80,7 @@
       "type": "string",
       "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}**/",
+      "default": "/**{lineEnding}  @file{lineEnding}  @brief <Your brief here>{lineEnding}{lineEnding}  <h4> SAS Macros </h4>{lineEnding}{lineEnding}**/",
       "examples": []
     },
     "noGremlins": {
@@ -102,7 +108,7 @@
       "type": "boolean",
       "title": "hasMacroNameInMend",
       "description": "Enforces the presence of macro names in %mend statements. Shows a warning for %mend statements with missing or mismatched macro names.",
-      "default": false,
+      "default": true,
       "examples": [true, false]
     },
     "hasMacroParentheses": {
@@ -193,6 +199,22 @@
       "default": true,
       "examples": [true, false]
     },
+    "noUndeclaredMacros": {
+      "$id": "#/properties/noUndeclaredMacros",
+      "type": "boolean",
+      "title": "noUndeclaredMacros",
+      "description": "Reports a warning for each macro a file invokes without declaring it in the `<h4> SAS Macros </h4>` or `<h4> Other Macros </h4>` section of the header. Macros that ship with SAS are always considered declared. The formatter resolves the warning by adding the macro names to the header, sorted alphabetically.",
+      "default": true,
+      "examples": [true, false]
+    },
+    "noUnusedMacros": {
+      "$id": "#/properties/noUnusedMacros",
+      "type": "boolean",
+      "title": "noUnusedMacros",
+      "description": "Reports a warning for each macro declared in the `<h4> SAS Macros </h4>` section of the header that the file itself never invokes. The formatter removes the unused entries. A macro can be referenced indirectly, so the warning is advisory.",
+      "default": true,
+      "examples": [true, false]
+    },
     "lineEndings": {
       "$id": "#/properties/lineEndings",
       "type": "string",
@@ -215,8 +237,8 @@
       "type": "array",
       "title": "ignoreList",
       "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/tests", "tmp/scratch.sas"]
+      "default": [],
+      "examples": [["sasjsbuild/", "sasjsresults/"], ["sasjs/tests", "tmp/scratch.sas"]]
     },
     "hasRequiredMacroOptions": {
       "$id": "#/properties/hasRequiredMacroOptions",
@@ -344,6 +366,20 @@
           "enum": ["error", "warn"],
           "default": "warn"
         },
+        "noUndeclaredMacros": {
+          "$id": "#/properties/severityLevel/noUndeclaredMacros",
+          "title": "noUndeclaredMacros",
+          "type": "string",
+          "enum": ["error", "warn"],
+          "default": "warn"
+        },
+        "noUnusedMacros": {
+          "$id": "#/properties/severityLevel/noUnusedMacros",
+          "title": "noUnusedMacros",
+          "type": "string",
+          "enum": ["error", "warn"],
+          "default": "warn"
+        },
         "lineEndings": {
           "$id": "#/properties/severityLevel/lineEndings",
           "title": "lineEndings",