@sasjs/lint 3.0.0 → 4.1.0

package/utils/parseLintOverride.js

@@ -0,0 +1,109 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applyLintOverride = exports.getLintOverride = void 0;
+const getHeaderLinesCount_1 = require("./getHeaderLinesCount");
+const splitText_1 = require("./splitText");
+/**
+ * The tag that introduces a per-file override, with the object that must follow
+ * it. The tag has to start a header line, and the `{` has to come immediately
+ * after it, so a `@brief` that mentions the syntax in prose, a longer tag such
+ * as `@sasjslintFoo`, and a tag with something else after it are all left alone
+ * rather than read as an override.
+ */
+const marker = /^[^\w]*@sasjslint\s*\{/m;
+/**
+ * Reads a balanced JSON object from `start`, honouring strings and escapes so
+ * a brace inside a value does not end the scan early.
+ */
+const readObject = (text, start) => {
+    let depth = 0;
+    let inString = false;
+    let escaped = false;
+    for (let index = start; index < text.length; index++) {
+        const char = text[index];
+        if (inString) {
+            if (escaped)
+                escaped = false;
+            else if (char === '\\')
+                escaped = true;
+            else if (char === '"')
+                inString = false;
+            continue;
+        }
+        if (char === '"') {
+            inString = true;
+        }
+        else if (char === '{') {
+            depth++;
+        }
+        else if (char === '}') {
+            depth--;
+            if (depth === 0)
+                return text.slice(start, index + 1);
+        }
+    }
+    return null;
+};
+/**
+ * Reads the per-file override from the header of a file.
+ *
+ * The override is a `@sasjslint` tag followed by a JSON object, anywhere in the
+ * Doxygen header:
+ *
+ * ```
+ * /**
+ *   @file
+ *   @brief Calls the settlement API
+ *
+ *   @sasjslint {"maxHeaderLineLength": 200, "noUndeclaredMacros": false}
+ * **\/
+ * ```
+ *
+ * Only the header is read, so an override cannot be buried in the body of a
+ * file. A tag that is missing, unterminated, malformed or not an object is
+ * ignored rather than raised: the linter must not fail on bad input.
+ *
+ * @param {string} text - the text content of the file.
+ * @param {LintConfig} config - the resolved configuration, used to find the
+ * header and its line endings.
+ * @returns {object | null} the override, or null when there is none.
+ */
+const getLintOverride = (text, config) => {
+    if (!text)
+        return null;
+    const headerLinesCount = (0, getHeaderLinesCount_1.getHeaderLinesCount)(text, config);
+    if (!headerLinesCount)
+        return null;
+    const header = (0, splitText_1.splitText)(text, config).slice(0, headerLinesCount).join('\n');
+    const match = marker.exec(header);
+    if (!match)
+        return null;
+    // The match ends with the opening brace.
+    const brace = match.index + match[0].length - 1;
+    const body = readObject(header, brace);
+    if (!body)
+        return null;
+    try {
+        // The body always starts with `{`, so a successful parse is an object.
+        return JSON.parse(body);
+    }
+    catch (_a) {
+        return null;
+    }
+};
+exports.getLintOverride = getLintOverride;
+/**
+ * Returns the configuration to lint a file with: the given configuration, with
+ * the file's own `@sasjslint` override merged over it. The header wins, since
+ * it is the more specific statement.
+ *
+ * @param {string} text - the text content of the file.
+ * @param {LintConfig} config - the resolved configuration.
+ * @returns {LintConfig} the effective configuration.
+ */
+const applyLintOverride = (text, config) => {
+    const override = (0, exports.getLintOverride)(text, config);
+    return override ? config.override(override) : config;
+};
+exports.applyLintOverride = applyLintOverride;
+//# sourceMappingURL=parseLintOverride.js.map

package/utils/parseLintOverride.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parseLintOverride.js","sourceRoot":"","sources":["../../src/utils/parseLintOverride.ts"],"names":[],"mappings":";;;AACA,+DAA2D;AAC3D,2CAAuC;AAEvC;;;;;;GAMG;AACH,MAAM,MAAM,GAAG,yBAAyB,CAAA;AAExC;;;GAGG;AACH,MAAM,UAAU,GAAG,CAAC,IAAY,EAAE,KAAa,EAAiB,EAAE;IAChE,IAAI,KAAK,GAAG,CAAC,CAAA;IACb,IAAI,QAAQ,GAAG,KAAK,CAAA;IACpB,IAAI,OAAO,GAAG,KAAK,CAAA;IAEnB,KAAK,IAAI,KAAK,GAAG,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC;QACrD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAA;QAExB,IAAI,QAAQ,EAAE,CAAC;YACb,IAAI,OAAO;gBAAE,OAAO,GAAG,KAAK,CAAA;iBACvB,IAAI,IAAI,KAAK,IAAI;gBAAE,OAAO,GAAG,IAAI,CAAA;iBACjC,IAAI,IAAI,KAAK,GAAG;gBAAE,QAAQ,GAAG,KAAK,CAAA;YACvC,SAAQ;QACV,CAAC;QAED,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;YACjB,QAAQ,GAAG,IAAI,CAAA;QACjB,CAAC;aAAM,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;YACxB,KAAK,EAAE,CAAA;QACT,CAAC;aAAM,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;YACxB,KAAK,EAAE,CAAA;YACP,IAAI,KAAK,KAAK,CAAC;gBAAE,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,CAAC,CAAC,CAAA;QACtD,CAAC;IACH,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACI,MAAM,eAAe,GAAG,CAC7B,IAAY,EACZ,MAAkB,EACN,EAAE;IACd,IAAI,CAAC,IAAI;QAAE,OAAO,IAAI,CAAA;IAEtB,MAAM,gBAAgB,GAAG,IAAA,yCAAmB,EAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IAC1D,IAAI,CAAC,gBAAgB;QAAE,OAAO,IAAI,CAAA;IAElC,MAAM,MAAM,GAAG,IAAA,qBAAS,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAE5E,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IACjC,IAAI,CAAC,KAAK;QAAE,OAAO,IAAI,CAAA;IAEvB,yCAAyC;IACzC,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAA;IAE/C,MAAM,IAAI,GAAG,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;IACtC,IAAI,CAAC,IAAI;QAAE,OAAO,IAAI,CAAA;IAEtB,IAAI,CAAC;QACH,uEAAuE;QACvE,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IACzB,CAAC;IAAC,WAAM,CAAC;QACP,OAAO,IAAI,CAAA;IACb,CAAC;AACH,CAAC,CAAA;AA1BY,QAAA,eAAe,mBA0B3B;AAED;;;;;;;;GAQG;AACI,MAAM,iBAAiB,GAAG,CAC/B,IAAY,EACZ,MAAkB,EACN,EAAE;IACd,MAAM,QAAQ,GAAG,IAAA,uBAAe,EAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IAC9C,OAAO,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,CAAA;AACtD,CAAC,CAAA;AANY,QAAA,iBAAiB,qBAM7B"}