@pbiplint/core 0.1.0

package/dist/tmdl/parse.js

@@ -0,0 +1,196 @@
+import { unquoteName, unquoteValue } from "./quote.js";
+const HEADER = /^([A-Za-z_]\w*)(?:\s+(.+))?$/;
+const PROP = /^([A-Za-z_]\w*):(?:\s(.*))?$/;
+const REF = /^ref\s+([A-Za-z_]\w*)\s+(.+)$/;
+const tabIndent = (line) => {
+    let n = 0;
+    while (line[n] === "\t")
+        n++;
+    return n;
+};
+const leadingWs = (line) => line.length - line.trimStart().length;
+/** Split `<type> <name> [= expr]` on the first `=` outside single quotes. */
+function splitHeader(content) {
+    let inQuote = false;
+    let eqAt = -1;
+    for (let i = 0; i < content.length; i++) {
+        const ch = content[i];
+        if (ch === "'")
+            inQuote = !inQuote;
+        else if (ch === "=" && !inQuote) {
+            eqAt = i;
+            break;
+        }
+    }
+    const left = (eqAt >= 0 ? content.slice(0, eqAt) : content).trim();
+    const inline = eqAt >= 0 ? content.slice(eqAt + 1).trim() : "";
+    const m = HEADER.exec(left);
+    if (!m)
+        return null;
+    return {
+        type: m[1],
+        name: m[2] === undefined ? undefined : unquoteName(m[2]),
+        hasEq: eqAt >= 0,
+        inline,
+    };
+}
+/**
+ * Generic TMDL tree parser. Unknown object types and properties parse as generic nodes,
+ * so a construct this code has never seen never aborts a run.
+ */
+export function parseTmdl(file, text) {
+    // Power BI Desktop writes TMDL as UTF-8 with a BOM; it is not part of the first line.
+    const body = text.charCodeAt(0) === 0xfeff ? text.slice(1) : text;
+    const lines = body.replace(/\r\n?/g, "\n").split("\n");
+    const roots = [];
+    const issues = [];
+    const stack = [];
+    let pendingDescription = [];
+    // The first `///` line of the pending run, for the issue reported when it leads nowhere.
+    let descriptionLine = 0;
+    let descriptionText = "";
+    let i = 0;
+    while (i < lines.length) {
+        const raw = lines[i];
+        const lineNo = i + 1;
+        if (raw.trim() === "") {
+            // Tabular Editor's TMDL reader rejects a blank line after a `///` description, so a
+            // description separated from its declaration never reaches it. Report and drop it.
+            if (pendingDescription.length) {
+                issues.push({
+                    file,
+                    line: descriptionLine,
+                    text: descriptionText,
+                    reason: "description is not followed by a declaration",
+                });
+                pendingDescription = [];
+            }
+            i++;
+            continue;
+        }
+        const indent = tabIndent(raw);
+        const content = raw.slice(indent);
+        if (content.startsWith("///")) {
+            if (!pendingDescription.length) {
+                descriptionLine = lineNo;
+                descriptionText = raw;
+            }
+            pendingDescription.push(content.replace(/^\/\/\/ ?/, ""));
+            i++;
+            continue;
+        }
+        if (/^\s/.test(content)) {
+            issues.push({
+                file,
+                line: lineNo,
+                text: raw,
+                reason: "space indentation (TMDL requires tabs)",
+            });
+            i++;
+            continue;
+        }
+        // Indented multi-line expression. The first non-blank line after the header sets the block
+        // indentation; the block continues while lines are blank or indented at least that much.
+        const collectBlock = () => {
+            let j = i + 1;
+            while (j < lines.length && lines[j].trim() === "")
+                j++;
+            if (j >= lines.length)
+                return "";
+            const blockIndent = leadingWs(lines[j]);
+            if (blockIndent <= indent)
+                return "";
+            const out = [];
+            let lastNonBlank = -1;
+            for (; j < lines.length; j++) {
+                const l = lines[j];
+                if (l.trim() === "") {
+                    out.push("");
+                    continue;
+                }
+                if (leadingWs(l) < blockIndent)
+                    break;
+                out.push(l.slice(blockIndent));
+                lastNonBlank = out.length - 1;
+            }
+            i = j - 1;
+            return out.slice(0, lastNonBlank + 1).join("\n");
+        };
+        // Fenced expression: header ends with ```; closed by a line that is only ```; that closing
+        // line's leading whitespace is the left boundary stripped from every line.
+        const collectFenced = () => {
+            const out = [];
+            let j = i + 1;
+            while (j < lines.length && lines[j].trim() !== "```") {
+                out.push(lines[j]);
+                j++;
+            }
+            if (j >= lines.length)
+                issues.push({ file, line: lineNo, text: raw, reason: "unterminated ``` fence" });
+            const boundary = j < lines.length ? leadingWs(lines[j]) : 0;
+            i = j;
+            return out.map((l) => l.slice(Math.min(boundary, leadingWs(l)))).join("\n");
+        };
+        const base = {
+            props: {},
+            children: [],
+            file,
+            line: lineNo,
+            indent,
+        };
+        let node;
+        let m;
+        if ((m = REF.exec(content))) {
+            node = { ...base, kind: "ref", type: m[1].toLowerCase(), name: unquoteName(m[2]) };
+        }
+        else if ((m = PROP.exec(content))) {
+            node = { ...base, kind: "prop", type: m[1].toLowerCase(), value: unquoteValue(m[2] ?? "") };
+        }
+        else {
+            const h = splitHeader(content);
+            if (!h) {
+                issues.push({ file, line: lineNo, text: raw, reason: "unrecognized line" });
+                i++;
+                continue;
+            }
+            if (h.hasEq) {
+                const value = h.inline === "```" ? collectFenced() : h.inline === "" ? collectBlock() : h.inline;
+                node =
+                    h.name === undefined
+                        ? { ...base, kind: "expr", type: h.type.toLowerCase(), value }
+                        : { ...base, kind: "object", type: h.type.toLowerCase(), name: h.name, value };
+            }
+            else if (h.name !== undefined) {
+                node = { ...base, kind: "object", type: h.type.toLowerCase(), name: h.name };
+            }
+            else {
+                node = { ...base, kind: "flag", type: h.type.toLowerCase() };
+            }
+        }
+        if (pendingDescription.length) {
+            node.description = pendingDescription.join("\n");
+            pendingDescription = [];
+        }
+        stack.length = indent;
+        const parent = indent > 0 ? stack[indent - 1] : undefined;
+        if (indent > 0 && !parent) {
+            issues.push({ file, line: lineNo, text: raw, reason: "orphan indentation" });
+            i++;
+            continue;
+        }
+        if (parent) {
+            if (node.kind === "prop" || node.kind === "expr")
+                parent.props[node.type] = node.value ?? "";
+            else if (node.kind === "flag")
+                parent.props[node.type] = true;
+            parent.children.push(node);
+        }
+        else {
+            roots.push(node);
+        }
+        stack[indent] = node;
+        i++;
+    }
+    return { file, roots, issues, lineCount: lines.length };
+}
+//# sourceMappingURL=parse.js.map

package/dist/tmdl/parse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse.js","sourceRoot":"","sources":["../../src/tmdl/parse.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAGvD,MAAM,MAAM,GAAG,8BAA8B,CAAC;AAC9C,MAAM,IAAI,GAAG,8BAA8B,CAAC;AAC5C,MAAM,GAAG,GAAG,+BAA+B,CAAC;AAE5C,MAAM,SAAS,GAAG,CAAC,IAAY,EAAU,EAAE;IACzC,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI;QAAE,CAAC,EAAE,CAAC;IAC7B,OAAO,CAAC,CAAC;AACX,CAAC,CAAC;AACF,MAAM,SAAS,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC,MAAM,CAAC;AAElF,6EAA6E;AAC7E,SAAS,WAAW,CAClB,OAAe;IAEf,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,IAAI,IAAI,GAAG,CAAC,CAAC,CAAC;IACd,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACxC,MAAM,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;QACtB,IAAI,EAAE,KAAK,GAAG;YAAE,OAAO,GAAG,CAAC,OAAO,CAAC;aAC9B,IAAI,EAAE,KAAK,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;YAChC,IAAI,GAAG,CAAC,CAAC;YACT,MAAM;QACR,CAAC;IACH,CAAC;IACD,MAAM,IAAI,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC;IACnE,MAAM,MAAM,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAC/D,MAAM,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5B,IAAI,CAAC,CAAC;QAAE,OAAO,IAAI,CAAC;IACpB,OAAO;QACL,IAAI,EAAE,CAAC,CAAC,CAAC,CAAE;QACX,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACxD,KAAK,EAAE,IAAI,IAAI,CAAC;QAChB,MAAM;KACP,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,SAAS,CAAC,IAAY,EAAE,IAAY;IAClD,sFAAsF;IACtF,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAClE,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACvD,MAAM,KAAK,GAAe,EAAE,CAAC;IAC7B,MAAM,MAAM,GAAiB,EAAE,CAAC;IAChC,MAAM,KAAK,GAAe,EAAE,CAAC;IAC7B,IAAI,kBAAkB,GAAa,EAAE,CAAC;IACtC,yFAAyF;IACzF,IAAI,eAAe,GAAG,CAAC,CAAC;IACxB,IAAI,eAAe,GAAG,EAAE,CAAC;IACzB,IAAI,CAAC,GAAG,CAAC,CAAC;IAEV,OAAO,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;QACxB,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC;QACtB,MAAM,MAAM,GAAG,CAAC,GAAG,CAAC,CAAC;QACrB,IAAI,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YACtB,oFAAoF;YACpF,mFAAmF;YACnF,IAAI,kBAAkB,CAAC,MAAM,EAAE,CAAC;gBAC9B,MAAM,CAAC,IAAI,CAAC;oBACV,IAAI;oBACJ,IAAI,EAAE,eAAe;oBACrB,IAAI,EAAE,eAAe;oBACrB,MAAM,EAAE,8CAA8C;iBACvD,CAAC,CAAC;gBACH,kBAAkB,GAAG,EAAE,CAAC;YAC1B,CAAC;YACD,CAAC,EAAE,CAAC;YACJ,SAAS;QACX,CAAC;QACD,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;QAC9B,MAAM,OAAO,GAAG,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAClC,IAAI,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9B,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,CAAC;gBAC/B,eAAe,GAAG,MAAM,CAAC;gBACzB,eAAe,GAAG,GAAG,CAAC;YACxB,CAAC;YACD,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC;YAC1D,CAAC,EAAE,CAAC;YACJ,SAAS;QACX,CAAC;QACD,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YACxB,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI;gBACJ,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE,GAAG;gBACT,MAAM,EAAE,wCAAwC;aACjD,CAAC,CAAC;YACH,CAAC,EAAE,CAAC;YACJ,SAAS;QACX,CAAC;QAED,2FAA2F;QAC3F,yFAAyF;QACzF,MAAM,YAAY,GAAG,GAAW,EAAE;YAChC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACd,OAAO,CAAC,GAAG,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,CAAC,CAAE,CAAC,IAAI,EAAE,KAAK,EAAE;gBAAE,CAAC,EAAE,CAAC;YACxD,IAAI,CAAC,IAAI,KAAK,CAAC,MAAM;gBAAE,OAAO,EAAE,CAAC;YACjC,MAAM,WAAW,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,CAAC;YACzC,IAAI,WAAW,IAAI,MAAM;gBAAE,OAAO,EAAE,CAAC;YACrC,MAAM,GAAG,GAAa,EAAE,CAAC;YACzB,IAAI,YAAY,GAAG,CAAC,CAAC,CAAC;YACtB,OAAO,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC7B,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC;gBACpB,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;oBACpB,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;oBACb,SAAS;gBACX,CAAC;gBACD,IAAI,SAAS,CAAC,CAAC,CAAC,GAAG,WAAW;oBAAE,MAAM;gBACtC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC;gBAC/B,YAAY,GAAG,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC;YAChC,CAAC;YACD,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACV,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnD,CAAC,CAAC;QAEF,2FAA2F;QAC3F,2EAA2E;QAC3E,MAAM,aAAa,GAAG,GAAW,EAAE;YACjC,MAAM,GAAG,GAAa,EAAE,CAAC;YACzB,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACd,OAAO,CAAC,GAAG,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,CAAC,CAAE,CAAC,IAAI,EAAE,KAAK,KAAK,EAAE,CAAC;gBACtD,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,CAAC;gBACpB,CAAC,EAAE,CAAC;YACN,CAAC;YACD,IAAI,CAAC,IAAI,KAAK,CAAC,MAAM;gBACnB,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,wBAAwB,EAAE,CAAC,CAAC;YACnF,MAAM,QAAQ,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC7D,CAAC,GAAG,CAAC,CAAC;YACN,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9E,CAAC,CAAC;QAEF,MAAM,IAAI,GAAG;YACX,KAAK,EAAE,EAAmC;YAC1C,QAAQ,EAAE,EAAgB;YAC1B,IAAI;YACJ,IAAI,EAAE,MAAM;YACZ,MAAM;SACP,CAAC;QACF,IAAI,IAAc,CAAC;QACnB,IAAI,CAAyB,CAAC;QAC9B,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;YAC5B,IAAI,GAAG,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAE,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAE,CAAC,EAAE,CAAC;QACvF,CAAC;aAAM,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;YACpC,IAAI,GAAG,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAE,CAAC,WAAW,EAAE,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;QAC/F,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;YAC/B,IAAI,CAAC,CAAC,EAAE,CAAC;gBACP,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,mBAAmB,EAAE,CAAC,CAAC;gBAC5E,CAAC,EAAE,CAAC;gBACJ,SAAS;YACX,CAAC;YACD,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC;gBACZ,MAAM,KAAK,GACT,CAAC,CAAC,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,EAAE,CAAC,CAAC,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;gBACrF,IAAI;oBACF,CAAC,CAAC,IAAI,KAAK,SAAS;wBAClB,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,KAAK,EAAE;wBAC9D,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC;YACrF,CAAC;iBAAM,IAAI,CAAC,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;gBAChC,IAAI,GAAG,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;YAC/E,CAAC;iBAAM,CAAC;gBACN,IAAI,GAAG,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YAC/D,CAAC;QACH,CAAC;QAED,IAAI,kBAAkB,CAAC,MAAM,EAAE,CAAC;YAC9B,IAAI,CAAC,WAAW,GAAG,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACjD,kBAAkB,GAAG,EAAE,CAAC;QAC1B,CAAC;QACD,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC;QACtB,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC1D,IAAI,MAAM,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YAC1B,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,oBAAoB,EAAE,CAAC,CAAC;YAC7E,CAAC,EAAE,CAAC;YACJ,SAAS;QACX,CAAC;QACD,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM;gBAAE,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;iBACxF,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM;gBAAE,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;YAC9D,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7B,CAAC;aAAM,CAAC;YACN,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnB,CAAC;QACD,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QACrB,CAAC,EAAE,CAAC;IACN,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC;AAC1D,CAAC"}

package/dist/tmdl/quote.d.ts

@@ -0,0 +1,5 @@
+/** Strip single quotes from a TMDL object name; `''` inside is one quote. */
+export declare function unquoteName(s: string): string;
+/** Strip double quotes from a TMDL property value; `""` inside is one quote. */
+export declare function unquoteValue(s: string): string;
+//# sourceMappingURL=quote.d.ts.map

package/dist/tmdl/quote.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"quote.d.ts","sourceRoot":"","sources":["../../src/tmdl/quote.ts"],"names":[],"mappings":"AAAA,6EAA6E;AAC7E,wBAAgB,WAAW,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAK7C;AAED,gFAAgF;AAChF,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAK9C"}

package/dist/tmdl/quote.js

@@ -0,0 +1,15 @@
+/** Strip single quotes from a TMDL object name; `''` inside is one quote. */
+export function unquoteName(s) {
+    const t = s.trim();
+    if (t.length >= 2 && t.startsWith("'") && t.endsWith("'"))
+        return t.slice(1, -1).replace(/''/g, "'");
+    return t;
+}
+/** Strip double quotes from a TMDL property value; `""` inside is one quote. */
+export function unquoteValue(s) {
+    const t = s.trim();
+    if (t.length >= 2 && t.startsWith('"') && t.endsWith('"'))
+        return t.slice(1, -1).replace(/""/g, '"');
+    return t;
+}
+//# sourceMappingURL=quote.js.map

package/dist/tmdl/quote.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"quote.js","sourceRoot":"","sources":["../../src/tmdl/quote.ts"],"names":[],"mappings":"AAAA,6EAA6E;AAC7E,MAAM,UAAU,WAAW,CAAC,CAAS;IACnC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;IACnB,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC;QACvD,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAC5C,OAAO,CAAC,CAAC;AACX,CAAC;AAED,gFAAgF;AAChF,MAAM,UAAU,YAAY,CAAC,CAAS;IACpC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;IACnB,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC;QACvD,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAC5C,OAAO,CAAC,CAAC;AACX,CAAC"}

package/dist/tmdl/types.d.ts

@@ -0,0 +1,32 @@
+export type TmdlNodeKind = "object" | "prop" | "flag" | "ref" | "expr";
+/** One line of TMDL and everything indented beneath it. `type` and `props` keys are lowercased. */
+export interface TmdlNode {
+    kind: TmdlNodeKind;
+    /** Object type (`table`, `column`), property key (`datatype`), flag (`ishidden`), or ref target type. */
+    type: string;
+    /** Unquoted object name, for `object` and `ref` nodes. */
+    name?: string;
+    /** Property value (unquoted) for `prop`; expression text for `expr` and for `object` nodes declared with `=`. */
+    value?: string;
+    /** Child properties, flags, and expressions by lowercased key. Flags are `true`. */
+    props: Record<string, string | true>;
+    children: TmdlNode[];
+    /** Joined `///` lines that preceded the declaration. */
+    description?: string;
+    file: string;
+    line: number;
+    indent: number;
+}
+export interface ParseIssue {
+    file: string;
+    line: number;
+    text: string;
+    reason: string;
+}
+export interface ParsedFile {
+    file: string;
+    roots: TmdlNode[];
+    issues: ParseIssue[];
+    lineCount: number;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/tmdl/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/tmdl/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,YAAY,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,CAAC;AAEvE,mGAAmG;AACnG,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,YAAY,CAAC;IACnB,yGAAyG;IACzG,IAAI,EAAE,MAAM,CAAC;IACb,0DAA0D;IAC1D,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,iHAAiH;IACjH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,oFAAoF;IACpF,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,CAAC;IACrC,QAAQ,EAAE,QAAQ,EAAE,CAAC;IACrB,wDAAwD;IACxD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,QAAQ,EAAE,CAAC;IAClB,MAAM,EAAE,UAAU,EAAE,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;CACnB"}

package/dist/tmdl/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/tmdl/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/tmdl/types.ts"],"names":[],"mappings":""}

package/dist/version.d.ts

@@ -0,0 +1,2 @@
+export declare const VERSION = "0.1.0";
+//# sourceMappingURL=version.d.ts.map

package/dist/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,OAAO,UAAU,CAAC"}

package/dist/version.js

@@ -0,0 +1,3 @@
+// Generated by scripts/sync-version.mjs from packages/core/package.json. Do not edit by hand.
+export const VERSION = "0.1.0";
+//# sourceMappingURL=version.js.map

package/dist/version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAAA,8FAA8F;AAC9F,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC"}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@pbiplint/core",
+  "version": "0.1.0",
+  "description": "Best-practice linter core for Power BI semantic models (TMDL). Runs in the browser and in Node, makes no network calls.",
+  "keywords": [
+    "power-bi",
+    "tmdl",
+    "semantic-model",
+    "pbip",
+    "linter",
+    "best-practices",
+    "tabular"
+  ],
+  "license": "AGPL-3.0-or-later",
+  "author": "McKinley Consulting",
+  "homepage": "https://pbiplint.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/pbiplint/pbiplint.git",
+    "directory": "packages/core"
+  },
+  "bugs": {
+    "url": "https://github.com/pbiplint/pbiplint/issues"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src",
+    "README.md",
+    "NOTICE",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json && node scripts/copy-notices.mjs",
+    "prepack": "npm run build"
+  },
+  "engines": {
+    "node": ">=20"
+  }
+}

package/src/engine/config.ts

@@ -0,0 +1,91 @@
+import type { Rule, Severity } from "../rules/types.js";
+
+export type SeverityName = "info" | "warning" | "error";
+
+/** Shape of pbiplint.config.json. */
+export interface PbiplintConfig {
+  /** Optional JSON Schema URL, so an editor can validate and complete the file. Ignored here. */
+  $schema?: string;
+  /** Per rule: "off" disables it; a severity name overrides its severity. */
+  rules?: Record<string, "off" | SeverityName>;
+  /** Lowest severity that makes the CLI exit nonzero. Default "error". */
+  failOn?: SeverityName | "none";
+}
+
+export interface ResolvedConfig {
+  disabled: Set<string>;
+  severity: Map<string, Severity>;
+  failOn: Severity | null;
+}
+
+export class ConfigError extends Error {}
+
+export interface BoundConfig {
+  /** The same settings keyed by the rules' own ids. */
+  config: ResolvedConfig;
+  /** Ids from the config that match no rule, as written. */
+  unknownRules: string[];
+}
+
+/**
+ * Map the config's rule ids onto `rules` without regard to case, so `hide_foreign_keys` reaches
+ * HIDE_FOREIGN_KEYS, and list the ids that reach nothing so a typo never disables a rule silently.
+ */
+export function bindConfig(config: ResolvedConfig, rules: Rule[]): BoundConfig {
+  const idByUpper = new Map(rules.map((r) => [r.id.toUpperCase(), r.id]));
+  const bound: ResolvedConfig = { disabled: new Set(), severity: new Map(), failOn: config.failOn };
+  const unknownRules: string[] = [];
+  for (const id of config.disabled) {
+    const real = idByUpper.get(id.toUpperCase());
+    if (real === undefined) unknownRules.push(id);
+    else bound.disabled.add(real);
+  }
+  for (const [id, severity] of config.severity) {
+    const real = idByUpper.get(id.toUpperCase());
+    if (real === undefined) unknownRules.push(id);
+    else bound.severity.set(real, severity);
+  }
+  return { config: bound, unknownRules };
+}
+
+export const SEVERITY_BY_NAME: Record<SeverityName, Severity> = { info: 1, warning: 2, error: 3 };
+
+const isRecord = (v: unknown): v is Record<string, unknown> =>
+  typeof v === "object" && v !== null && !Array.isArray(v);
+
+export function isResolvedConfig(v: unknown): v is ResolvedConfig {
+  return isRecord(v) && v.disabled instanceof Set && v.severity instanceof Map;
+}
+
+export function resolveConfig(raw: unknown = {}): ResolvedConfig {
+  if (!isRecord(raw)) throw new ConfigError("pbiplint.config.json must be a JSON object");
+  for (const k of Object.keys(raw))
+    if (k !== "rules" && k !== "failOn" && k !== "$schema")
+      throw new ConfigError(`pbiplint.config.json: unknown key "${k}"`);
+  const out: ResolvedConfig = { disabled: new Set(), severity: new Map(), failOn: 3 };
+  if (raw.rules !== undefined) {
+    if (!isRecord(raw.rules))
+      throw new ConfigError(
+        'pbiplint.config.json: "rules" must be an object of rule id to "off" | "info" | "warning" | "error"',
+      );
+    for (const [id, v] of Object.entries(raw.rules)) {
+      if (v === "off") out.disabled.add(id);
+      else if (v === "info" || v === "warning" || v === "error")
+        out.severity.set(id, SEVERITY_BY_NAME[v]);
+      else
+        throw new ConfigError(
+          `pbiplint.config.json: rules["${id}"] must be "off", "info", "warning", or "error"`,
+        );
+    }
+  }
+  if (raw.failOn !== undefined) {
+    if (raw.failOn === "none") out.failOn = null;
+    else if (raw.failOn === "info" || raw.failOn === "warning" || raw.failOn === "error")
+      out.failOn = SEVERITY_BY_NAME[raw.failOn];
+    else
+      throw new ConfigError(
+        'pbiplint.config.json: "failOn" must be "info", "warning", "error", or "none"',
+      );
+  }
+  return out;
+}

package/src/engine/ignore.ts

@@ -0,0 +1,18 @@
+import type { Named } from "../model/types.js";
+import { unquoteValue } from "../tmdl/quote.js";
+
+export const IGNORE_ANNOTATION = "pbiplint.ignore";
+
+/**
+ * True when the object carries `annotation pbiplint.ignore = RULE_A, RULE_B` naming this rule, or
+ * `= *`. Ids are matched without regard to case, so a hand-typed lowercase id still works.
+ */
+export function isIgnored(object: Named | undefined, ruleId: string): boolean {
+  const raw = object?.annotations[IGNORE_ANNOTATION];
+  if (raw === undefined) return false;
+  const wanted = ruleId.toUpperCase();
+  return unquoteValue(raw)
+    .split(",")
+    .map((s) => s.trim())
+    .some((s) => s === "*" || s.toUpperCase() === wanted);
+}

package/src/engine/lint.ts

@@ -0,0 +1,79 @@
+import { buildIndexes } from "../index/build.js";
+import { buildModel } from "../model/build.js";
+import type { Model } from "../model/types.js";
+import { defaultRules } from "../rules/index.js";
+import type { Finding, Rule } from "../rules/types.js";
+import { parseTmdl } from "../tmdl/parse.js";
+import {
+  bindConfig,
+  isResolvedConfig,
+  resolveConfig,
+  type PbiplintConfig,
+  type ResolvedConfig,
+} from "./config.js";
+import { rank, type RankedGroup } from "./rank.js";
+import { runRules, type RuleError, type SkippedRule } from "./run.js";
+
+export interface LintFile {
+  /** Path relative to the model root, forward slashes, e.g. `definition/tables/Sales.tmdl`. */
+  path: string;
+  text: string;
+}
+
+export interface LintOptions {
+  config?: PbiplintConfig | ResolvedConfig;
+  rules?: Rule[];
+}
+
+export interface LintSummary {
+  files: number;
+  findings: number;
+  errors: number;
+  warnings: number;
+  infos: number;
+  rulesRun: number;
+  rulesSkipped: SkippedRule[];
+  ruleErrors: RuleError[];
+  ignored: number;
+  /** Rule ids named in the config that match no rule, as written there. */
+  unknownRules: string[];
+}
+
+export interface LintResult {
+  model: Model;
+  findings: Finding[];
+  groups: RankedGroup[];
+  summary: LintSummary;
+  /** True when any finding's effective severity is at or above the configured failOn. */
+  failed: boolean;
+}
+
+/** The one call the web app and the CLI both make. Pure: no I/O, no network. */
+export function lint(files: LintFile[], options: LintOptions = {}): LintResult {
+  const rules = options.rules ?? defaultRules;
+  const { config, unknownRules } = bindConfig(
+    isResolvedConfig(options.config) ? options.config : resolveConfig(options.config),
+    rules,
+  );
+  const parsed = files.map((f) => parseTmdl(f.path, f.text));
+  const model = buildModel(parsed);
+  const indexes = buildIndexes(model);
+  const run = runRules(model, indexes, rules, config);
+  const groups = rank(run.findings, rules, config);
+  const count = (severity: number) =>
+    groups.filter((g) => g.rule.severity === severity).reduce((n, g) => n + g.findings.length, 0);
+  const summary: LintSummary = {
+    files: files.length,
+    findings: run.findings.length,
+    errors: count(3),
+    warnings: count(2),
+    infos: count(1),
+    rulesRun: run.rulesRun.length,
+    rulesSkipped: run.rulesSkipped,
+    ruleErrors: run.ruleErrors,
+    ignored: run.ignored,
+    unknownRules,
+  };
+  const failed = config.failOn !== null && groups.some((g) => g.rule.severity >= config.failOn!);
+  return { model, findings: run.findings, groups, summary, failed };
+}

package/src/engine/rank.ts

@@ -0,0 +1,67 @@
+import { ruleUrl, slug } from "../model/names.js";
+import {
+  CATEGORY_ORDER,
+  type Category,
+  type Finding,
+  type Rule,
+  type RuleStatus,
+  type Severity,
+} from "../rules/types.js";
+import type { ResolvedConfig } from "./config.js";
+
+export interface RuleSummary {
+  id: string;
+  name: string;
+  category: Category;
+  /** Effective severity after config overrides. */
+  severity: Severity;
+  slug: string;
+  url: string;
+  status: RuleStatus;
+}
+
+export interface RankedGroup {
+  rule: RuleSummary;
+  findings: Finding[];
+}
+
+export const effectiveSeverity = (rule: Rule, config: ResolvedConfig): Severity =>
+  config.severity.get(rule.id) ?? rule.severity;
+
+export function summarizeRule(rule: Rule, config: ResolvedConfig): RuleSummary {
+  return {
+    id: rule.id,
+    name: rule.name,
+    category: rule.category,
+    severity: effectiveSeverity(rule, config),
+    slug: slug(rule.id),
+    url: ruleUrl(rule.id),
+    status: rule.status,
+  };
+}
+
+/**
+ * Group findings by rule and order the groups by severity (error first), category priority,
+ * finding count (more first), then rule id. Findings inside a group keep model order.
+ */
+export function rank(findings: Finding[], rules: Rule[], config: ResolvedConfig): RankedGroup[] {
+  const byId = new Map(rules.map((r) => [r.id, r]));
+  const groups = new Map<string, RankedGroup>();
+  for (const f of findings) {
+    let g = groups.get(f.ruleId);
+    if (!g) {
+      const rule = byId.get(f.ruleId);
+      if (!rule) throw new Error(`Finding for unknown rule ${f.ruleId}`);
+      g = { rule: summarizeRule(rule, config), findings: [] };
+      groups.set(f.ruleId, g);
+    }
+    g.findings.push(f);
+  }
+  return [...groups.values()].sort(
+    (a, b) =>
+      b.rule.severity - a.rule.severity ||
+      CATEGORY_ORDER.indexOf(a.rule.category) - CATEGORY_ORDER.indexOf(b.rule.category) ||
+      b.findings.length - a.findings.length ||
+      a.rule.id.localeCompare(b.rule.id),
+  );
+}