skir 0.0.1 → 0.0.2

package/dist/doc_comment_parser.js

@@ -0,0 +1,219 @@
+import { assert } from "node:console";
+export function parseDocComments(docComments) {
+    const parser = new DocCommentsParser(docComments);
+    return parser.parse();
+}
+class DocCommentsParser {
+    constructor(docComments) {
+        this.docComments = docComments;
+        this.pieces = [];
+        this.errors = [];
+        this.currentText = "";
+        this.docCommentIndex = -1;
+        this.charIndex = -1;
+        this.contentOffset = -1;
+    }
+    parse() {
+        while (this.nextDocComment()) {
+            this.parseCurrentDocComment();
+        }
+        // Add any remaining text
+        if (this.currentText.length > 0) {
+            this.pieces.push({ kind: "text", text: this.currentText });
+        }
+        return {
+            result: {
+                pieces: this.pieces,
+            },
+            errors: this.errors,
+        };
+    }
+    parseCurrentDocComment() {
+        // Matches unescaped [ or ], OR escaped [[ or ]]
+        const specialCharRegex = /\[\[|\]\]|\[|\]/g;
+        while (this.charIndex < this.content.length) {
+            // Find next special character or escaped bracket
+            specialCharRegex.lastIndex = this.charIndex;
+            const match = specialCharRegex.exec(this.content);
+            if (!match) {
+                // No more special characters, add rest as text
+                this.currentText += this.content.slice(this.charIndex);
+                break;
+            }
+            // Add text before the special character
+            if (match.index > this.charIndex) {
+                this.currentText += this.content.slice(this.charIndex, match.index);
+            }
+            const matched = match[0];
+            this.charIndex = match.index;
+            if (matched === "[[") {
+                // Escaped left bracket
+                this.currentText += "[";
+                this.charIndex += 2;
+            }
+            else if (matched === "]]") {
+                // Escaped right bracket
+                this.currentText += "]";
+                this.charIndex += 2;
+            }
+            else if (matched === "[") {
+                // Start of a reference - save current text if any
+                if (this.currentText.length > 0) {
+                    this.pieces.push({ kind: "text", text: this.currentText });
+                    this.currentText = "";
+                }
+                // Parse the reference
+                const reference = this.parseReference();
+                this.pieces.push(reference);
+            }
+            else if (matched === "]") {
+                // Unmatched right bracket - treat as text
+                this.currentText += matched;
+                this.charIndex++;
+            }
+        }
+        // Add newline between comment lines (except after the last line)
+        if (this.docCommentIndex < this.docComments.length - 1) {
+            this.currentText += "\n";
+        }
+    }
+    parseReference() {
+        const { content, docComment } = this;
+        const leftBracketCharIndex = this.charIndex;
+        const startPosition = docComment.position + leftBracketCharIndex;
+        const rightBracketCharIndex = content.indexOf("]", leftBracketCharIndex);
+        // End position: right after the closing bracket or at end of the line if
+        // not found.
+        const endCharIndex = rightBracketCharIndex < 0 ? content.length : rightBracketCharIndex + 1;
+        const referenceText = content.slice(leftBracketCharIndex, endCharIndex);
+        const referenceRange = {
+            text: referenceText,
+            originalText: referenceText,
+            position: startPosition,
+            line: docComment.line,
+            colNumber: startPosition - docComment.line.position,
+        };
+        let hasError = false;
+        if (rightBracketCharIndex < 0) {
+            hasError = true;
+            this.errors.push({
+                token: referenceRange,
+                message: "Unterminated reference",
+            });
+        }
+        // Move past the left bracket
+        this.charIndex++;
+        const wordRegex = /[a-zA-Z][_a-zA-Z0-9]*/g;
+        const tokens = [];
+        while (this.charIndex < endCharIndex) {
+            const char = content[this.charIndex];
+            const position = docComment.position + this.charIndex;
+            const makeToken = (text) => ({
+                text: text,
+                originalText: text,
+                position: position,
+                line: docComment.line,
+                colNumber: position - docComment.line.position,
+            });
+            if (char === ".") {
+                // Dot token
+                tokens.push(makeToken("."));
+                this.charIndex++;
+            }
+            else if (/^[a-zA-Z]/.test(char)) {
+                // Start of a word token - use regex to match the whole word
+                wordRegex.lastIndex = this.charIndex;
+                const match = wordRegex.exec(content);
+                const word = match[0];
+                tokens.push(makeToken(word));
+                this.charIndex += word.length;
+            }
+            else if (char === "]") {
+                // Reached the end of the reference
+                tokens.push(makeToken("]"));
+                this.charIndex++;
+            }
+            else {
+                // Invalid character in reference (including whitespace)
+                const column = this.docComment.colNumber + this.charIndex;
+                hasError = true;
+                this.errors.push({
+                    token: referenceRange,
+                    message: `Invalid character in reference at column ${column + 1}`,
+                });
+                // Exit loop
+                this.charIndex = endCharIndex;
+            }
+        }
+        const nameChain = hasError ? [] : this.parseNameChain(tokens);
+        return {
+            kind: "reference",
+            nameChain: nameChain,
+            absolute: tokens[0]?.text === ".",
+            referee: undefined,
+            docComment: this.docComment,
+            referenceRange: referenceRange,
+        };
+    }
+    parseNameChain(tokens) {
+        const nameChain = [];
+        let expect = "identifier or '.'";
+        for (const token of tokens) {
+            let expected;
+            if (/^[a-zA-Z]/.test(token.text)) {
+                expected = expect === "identifier or '.'" || expect === "identifier";
+                expect = "'.' or ']'";
+                nameChain.push(token);
+            }
+            else if (token.text === ".") {
+                expected = expect === "identifier or '.'" || expect === "'.' or ']'";
+                expect = "identifier";
+            }
+            else {
+                assert(token.text === "]");
+                expected = expect === "'.' or ']'";
+            }
+            if (!expected) {
+                this.errors.push({
+                    token: token,
+                    expected: expect,
+                });
+                return [];
+            }
+            if (token.text === "]") {
+                return nameChain;
+            }
+        }
+        // An error has already been pushed to signify the unterminated reference.
+        return [];
+    }
+    /// The current doc comment being parsed.
+    get docComment() {
+        return this.docComments[this.docCommentIndex];
+    }
+    /// The text of the current doc comment being parsed.
+    get content() {
+        return this.docComment.text;
+    }
+    nextDocComment() {
+        if (this.docCommentIndex < this.docComments.length - 1) {
+            this.docCommentIndex++;
+            const { content } = this;
+            if (content.startsWith("/// ")) {
+                this.contentOffset = 4;
+            }
+            else if (content.startsWith("///")) {
+                this.contentOffset = 3;
+            }
+            else {
+                throw new Error("Expected doc comment to start with ///");
+            }
+            this.charIndex = this.contentOffset;
+            return true;
+        }
+        else {
+            return false;
+        }
+    }
+}
+//# sourceMappingURL=doc_comment_parser.js.map

package/dist/doc_comment_parser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"doc_comment_parser.js","sourceRoot":"","sources":["../src/doc_comment_parser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAUtC,MAAM,UAAU,gBAAgB,CAAC,WAA6B;IAC5D,MAAM,MAAM,GAAG,IAAI,iBAAiB,CAAC,WAAW,CAAC,CAAC;IAClD,OAAO,MAAM,CAAC,KAAK,EAAE,CAAC;AACxB,CAAC;AAED,MAAM,iBAAiB;IAQrB,YAA6B,WAA6B;QAA7B,gBAAW,GAAX,WAAW,CAAkB;QAPzC,WAAM,GAAe,EAAE,CAAC;QACxB,WAAM,GAAgB,EAAE,CAAC;QAClC,gBAAW,GAAG,EAAE,CAAC;QACjB,oBAAe,GAAG,CAAC,CAAC,CAAC;QACrB,cAAS,GAAG,CAAC,CAAC,CAAC;QACf,kBAAa,GAAG,CAAC,CAAC,CAAC;IAEkC,CAAC;IAE9D,KAAK;QACH,OAAO,IAAI,CAAC,cAAc,EAAE,EAAE,CAAC;YAC7B,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAChC,CAAC;QAED,yBAAyB;QACzB,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;QAC7D,CAAC;QAED,OAAO;YACL,MAAM,EAAE;gBACN,MAAM,EAAE,IAAI,CAAC,MAAM;aACpB;YACD,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,CAAC;IACJ,CAAC;IAEO,sBAAsB;QAC5B,gDAAgD;QAChD,MAAM,gBAAgB,GAAG,kBAAkB,CAAC;QAE5C,OAAO,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YAC5C,iDAAiD;YACjD,gBAAgB,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;YAC5C,MAAM,KAAK,GAAG,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAElD,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,+CAA+C;gBAC/C,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBACvD,MAAM;YACR,CAAC;YAED,wCAAwC;YACxC,IAAI,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;gBACjC,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;YACtE,CAAC;YAED,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACzB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC;YAE7B,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;gBACrB,uBAAuB;gBACvB,IAAI,CAAC,WAAW,IAAI,GAAG,CAAC;gBACxB,IAAI,CAAC,SAAS,IAAI,CAAC,CAAC;YACtB,CAAC;iBAAM,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;gBAC5B,wBAAwB;gBACxB,IAAI,CAAC,WAAW,IAAI,GAAG,CAAC;gBACxB,IAAI,CAAC,SAAS,IAAI,CAAC,CAAC;YACtB,CAAC;iBAAM,IAAI,OAAO,KAAK,GAAG,EAAE,CAAC;gBAC3B,kDAAkD;gBAClD,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAChC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;oBAC3D,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;gBACxB,CAAC;gBAED,sBAAsB;gBACtB,MAAM,SAAS,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;gBACxC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC9B,CAAC;iBAAM,IAAI,OAAO,KAAK,GAAG,EAAE,CAAC;gBAC3B,0CAA0C;gBAC1C,IAAI,CAAC,WAAW,IAAI,OAAO,CAAC;gBAC5B,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,CAAC;QACH,CAAC;QAED,iEAAiE;QACjE,IAAI,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvD,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC;QAC3B,CAAC;IACH,CAAC;IAEO,cAAc;QACpB,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;QAErC,MAAM,oBAAoB,GAAG,IAAI,CAAC,SAAS,CAAC;QAC5C,MAAM,aAAa,GAAG,UAAU,CAAC,QAAQ,GAAG,oBAAoB,CAAC;QAEjE,MAAM,qBAAqB,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,oBAAoB,CAAC,CAAC;QAEzE,yEAAyE;QACzE,aAAa;QACb,MAAM,YAAY,GAChB,qBAAqB,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,qBAAqB,GAAG,CAAC,CAAC;QAEzE,MAAM,aAAa,GAAG,OAAO,CAAC,KAAK,CAAC,oBAAoB,EAAE,YAAY,CAAC,CAAC;QACxE,MAAM,cAAc,GAAU;YAC5B,IAAI,EAAE,aAAa;YACnB,YAAY,EAAE,aAAa;YAC3B,QAAQ,EAAE,aAAa;YACvB,IAAI,EAAE,UAAU,CAAC,IAAI;YACrB,SAAS,EAAE,aAAa,GAAG,UAAU,CAAC,IAAI,CAAC,QAAQ;SACpD,CAAC;QAEF,IAAI,QAAQ,GAAG,KAAK,CAAC;QACrB,IAAI,qBAAqB,GAAG,CAAC,EAAE,CAAC;YAC9B,QAAQ,GAAG,IAAI,CAAC;YAChB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;gBACf,KAAK,EAAE,cAAc;gBACrB,OAAO,EAAE,wBAAwB;aAClC,CAAC,CAAC;QACL,CAAC;QAED,6BAA6B;QAC7B,IAAI,CAAC,SAAS,EAAE,CAAC;QAEjB,MAAM,SAAS,GAAG,wBAAwB,CAAC;QAE3C,MAAM,MAAM,GAAY,EAAE,CAAC;QAC3B,OAAO,IAAI,CAAC,SAAS,GAAG,YAAY,EAAE,CAAC;YACrC,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,SAAS,CAAE,CAAC;YACtC,MAAM,QAAQ,GAAG,UAAU,CAAC,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC;YAEtD,MAAM,SAAS,GAAG,CAAC,IAAY,EAAS,EAAE,CAAC,CAAC;gBAC1C,IAAI,EAAE,IAAI;gBACV,YAAY,EAAE,IAAI;gBAClB,QAAQ,EAAE,QAAQ;gBAClB,IAAI,EAAE,UAAU,CAAC,IAAI;gBACrB,SAAS,EAAE,QAAQ,GAAG,UAAU,CAAC,IAAI,CAAC,QAAQ;aAC/C,CAAC,CAAC;YAEH,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;gBACjB,YAAY;gBACZ,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;gBAC5B,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,CAAC;iBAAM,IAAI,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBAClC,4DAA4D;gBAC5D,SAAS,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;gBACrC,MAAM,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACtC,MAAM,IAAI,GAAG,KAAM,CAAC,CAAC,CAAC,CAAC;gBACvB,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;gBAC7B,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC;YAChC,CAAC;iBAAM,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;gBACxB,mCAAmC;gBACnC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;gBAC5B,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,CAAC;iBAAM,CAAC;gBACN,wDAAwD;gBACxD,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;gBAC1D,QAAQ,GAAG,IAAI,CAAC;gBAChB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;oBACf,KAAK,EAAE,cAAc;oBACrB,OAAO,EAAE,4CAA4C,MAAM,GAAG,CAAC,EAAE;iBAClE,CAAC,CAAC;gBACH,YAAY;gBACZ,IAAI,CAAC,SAAS,GAAG,YAAY,CAAC;YAChC,CAAC;QACH,CAAC;QAED,MAAM,SAAS,GAAG,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAE9D,OAAO;YACL,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,SAAS;YACpB,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,KAAK,GAAG;YACjC,OAAO,EAAE,SAAS;YAClB,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,cAAc,EAAE,cAAc;SAC/B,CAAC;IACJ,CAAC;IAEO,cAAc,CAAC,MAAwB;QAC7C,MAAM,SAAS,GAAY,EAAE,CAAC;QAC9B,IAAI,MAAM,GACR,mBAAmB,CAAC;QACtB,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,IAAI,QAAiB,CAAC;YACtB,IAAI,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;gBACjC,QAAQ,GAAG,MAAM,KAAK,mBAAmB,IAAI,MAAM,KAAK,YAAY,CAAC;gBACrE,MAAM,GAAG,YAAY,CAAC;gBACtB,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACxB,CAAC;iBAAM,IAAI,KAAK,CAAC,IAAI,KAAK,GAAG,EAAE,CAAC;gBAC9B,QAAQ,GAAG,MAAM,KAAK,mBAAmB,IAAI,MAAM,KAAK,YAAY,CAAC;gBACrE,MAAM,GAAG,YAAY,CAAC;YACxB,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC;gBAC3B,QAAQ,GAAG,MAAM,KAAK,YAAY,CAAC;YACrC,CAAC;YACD,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;oBACf,KAAK,EAAE,KAAK;oBACZ,QAAQ,EAAE,MAAM;iBACjB,CAAC,CAAC;gBACH,OAAO,EAAE,CAAC;YACZ,CAAC;YACD,IAAI,KAAK,CAAC,IAAI,KAAK,GAAG,EAAE,CAAC;gBACvB,OAAO,SAAS,CAAC;YACnB,CAAC;QACH,CAAC;QACD,0EAA0E;QAC1E,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,yCAAyC;IACzC,IAAY,UAAU;QACpB,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,eAAe,CAAE,CAAC;IACjD,CAAC;IAED,qDAAqD;IACrD,IAAY,OAAO;QACjB,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;IAC9B,CAAC;IAEO,cAAc;QACpB,IAAI,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvD,IAAI,CAAC,eAAe,EAAE,CAAC;YACvB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;YACzB,IAAI,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC/B,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC;YACzB,CAAC;iBAAM,IAAI,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;gBACrC,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC;YACzB,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;YAC5D,CAAC;YACD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,aAAa,CAAC;YACpC,OAAO,IAAI,CAAC;QACd,CAAC;aAAM,CAAC;YACN,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;CACF"}

package/dist/doc_comment_parser.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=doc_comment_parser.test.d.ts.map

package/dist/doc_comment_parser.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"doc_comment_parser.test.d.ts","sourceRoot":"","sources":["../src/doc_comment_parser.test.ts"],"names":[],"mappings":""}