skir 1.2.5 → 1.2.7

package/dist/dependency_manager.js

@@ -0,0 +1,109 @@
+import * as fs from "fs/promises";
+import path from "node:path";
+import { GetDependenciesFlow } from "./get_dependencies_flow.js";
+import { REAL_FILE_SYSTEM } from "./io.js";
+import { downloadPackage } from "./package_downloader.js";
+export class DependencyManager {
+    constructor(rootDir, githubToken, fileReader = REAL_FILE_SYSTEM, packageDownloader = downloadPackage) {
+        this.rootDir = rootDir;
+        this.githubToken = githubToken;
+        this.fileReader = fileReader;
+        this.packageDownloader = packageDownloader;
+    }
+    async getDependencies(dependencies, writeOption = "write") {
+        const flow = new GetDependenciesFlow(await this.readDependenciesFile(), this.githubToken, this.packageDownloader);
+        const result = await flow.run(dependencies);
+        if (result.kind === "success" &&
+            writeOption === "write" &&
+            result.changed) {
+            await this.writeOnDisk(result.packages);
+        }
+        return result;
+    }
+    async writeOnDisk(packages) {
+        // Write everything to a temp directory first, then rename it.
+        const relPathToContent = new Map();
+        for (const [packageId, pkg] of Object.entries(packages)) {
+            for (const [modulePath, content] of Object.entries(pkg.modules)) {
+                const relPath = packageId +
+                    modulePath
+                        .substring(packageId.length)
+                        .replace(/\.skir$/, ".readonly.skir");
+                relPathToContent.set(relPath, content);
+            }
+        }
+        relPathToContent.set(DEPENDENCIES_FILENAME, JSON.stringify(packages, null, 2));
+        const unixMillis = Date.now();
+        const tempDir = this.externalDir + "." + unixMillis + ".tmp";
+        const limboDir = this.externalDir + ".~" + unixMillis + ".tmp";
+        let tempDirExists = false;
+        let limboDirExists = false;
+        try {
+            await fs.mkdir(tempDir, { recursive: true });
+            tempDirExists = true;
+            // Write all files in parallel
+            const writePromises = Array.from(relPathToContent.entries()).map(async ([relPath, content]) => {
+                const fullPath = path.join(tempDir, relPath);
+                const dir = path.dirname(fullPath);
+                await fs.mkdir(dir, { recursive: true });
+                await fs.writeFile(fullPath, content, "utf-8");
+            });
+            await Promise.all(writePromises);
+            try {
+                await fs.rename(this.externalDir, limboDir);
+            }
+            catch (error) {
+                // It's okay if externalDir doesn't exist yet.
+                const doesNotExist = error &&
+                    typeof error === "object" &&
+                    "code" in error &&
+                    error.code === "ENOENT";
+                if (!doesNotExist) {
+                    throw error;
+                }
+            }
+            limboDirExists = true;
+            await fs.rename(tempDir, this.externalDir);
+            tempDirExists = false;
+            await fs.rm(limboDir, { recursive: true, force: true });
+            limboDirExists = false;
+        }
+        finally {
+            if (tempDirExists) {
+                try {
+                    await fs.rm(tempDir, { recursive: true, force: true });
+                }
+                catch (e) {
+                    console.error(e);
+                }
+            }
+            if (limboDirExists) {
+                try {
+                    await fs.rm(limboDir, { recursive: true, force: true });
+                }
+                catch (e) {
+                    console.error(e);
+                }
+            }
+        }
+    }
+    get externalDir() {
+        return path.join(this.rootDir, "skir-external");
+    }
+    async readDependenciesFile() {
+        const dependenciesPath = path.join(this.externalDir, DEPENDENCIES_FILENAME);
+        const content = await this.fileReader.readTextFileAsync(dependenciesPath);
+        if (content === undefined) {
+            return {};
+        }
+        try {
+            return JSON.parse(content);
+        }
+        catch (error) {
+            console.error(`Failed to parse ${dependenciesPath}:`, error);
+            return {};
+        }
+    }
+}
+const DEPENDENCIES_FILENAME = "dependencies.json";
+//# sourceMappingURL=dependency_manager.js.map

package/dist/dependency_manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dependency_manager.js","sourceRoot":"","sources":["../src/dependency_manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,aAAa,CAAC;AAClC,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAmB,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAQ1D,MAAM,OAAO,iBAAiB;IAC5B,YACmB,OAAe,EACf,WAA+B,EAC/B,aAA8B,gBAAgB,EAC9C,oBAAuC,eAAe;QAHtD,YAAO,GAAP,OAAO,CAAQ;QACf,gBAAW,GAAX,WAAW,CAAoB;QAC/B,eAAU,GAAV,UAAU,CAAoC;QAC9C,sBAAiB,GAAjB,iBAAiB,CAAqC;IACtE,CAAC;IAEJ,KAAK,CAAC,eAAe,CACnB,YAAgC,EAChC,cAAoC,OAAO;QAE3C,MAAM,IAAI,GAAG,IAAI,mBAAmB,CAClC,MAAM,IAAI,CAAC,oBAAoB,EAAE,EACjC,IAAI,CAAC,WAAW,EAChB,IAAI,CAAC,iBAAiB,CACvB,CAAC;QACF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QAC5C,IACE,MAAM,CAAC,IAAI,KAAK,SAAS;YACzB,WAAW,KAAK,OAAO;YACvB,MAAM,CAAC,OAAO,EACd,CAAC;YACD,MAAM,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC1C,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,KAAK,CAAC,WAAW,CAAC,QAAkB;QAC1C,8DAA8D;QAE9D,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAAkB,CAAC;QACnD,KAAK,MAAM,CAAC,SAAS,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;YACxD,KAAK,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;gBAChE,MAAM,OAAO,GACX,SAAS;oBACT,UAAU;yBACP,SAAS,CAAC,SAAS,CAAC,MAAM,CAAC;yBAC3B,OAAO,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;gBAC1C,gBAAgB,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YACzC,CAAC;QACH,CAAC;QACD,gBAAgB,CAAC,GAAG,CAClB,qBAAqB,EACrB,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAClC,CAAC;QAEF,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC9B,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,GAAG,GAAG,GAAG,UAAU,GAAG,MAAM,CAAC;QAC7D,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,GAAG,IAAI,GAAG,UAAU,GAAG,MAAM,CAAC;QAE/D,IAAI,aAAa,GAAG,KAAK,CAAC;QAC1B,IAAI,cAAc,GAAG,KAAK,CAAC;QAC3B,IAAI,CAAC;YACH,MAAM,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAC7C,aAAa,GAAG,IAAI,CAAC;YAErB,8BAA8B;YAC9B,MAAM,aAAa,GAAG,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAC9D,KAAK,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE;gBAC3B,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;gBAC7C,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBACnC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;gBACzC,MAAM,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;YACjD,CAAC,CACF,CAAC;YACF,MAAM,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;YAEjC,IAAI,CAAC;gBACH,MAAM,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;YAC9C,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,8CAA8C;gBAC9C,MAAM,YAAY,GAChB,KAAK;oBACL,OAAO,KAAK,KAAK,QAAQ;oBACzB,MAAM,IAAI,KAAK;oBACf,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC;gBAC1B,IAAI,CAAC,YAAY,EAAE,CAAC;oBAClB,MAAM,KAAK,CAAC;gBACd,CAAC;YACH,CAAC;YACD,cAAc,GAAG,IAAI,CAAC;YACtB,MAAM,EAAE,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YAC3C,aAAa,GAAG,KAAK,CAAC;YACtB,MAAM,EAAE,CAAC,EAAE,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;YACxD,cAAc,GAAG,KAAK,CAAC;QACzB,CAAC;gBAAS,CAAC;YACT,IAAI,aAAa,EAAE,CAAC;gBAClB,IAAI,CAAC;oBACH,MAAM,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;gBACzD,CAAC;gBAAC,OAAO,CAAC,EAAE,CAAC;oBACX,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBACnB,CAAC;YACH,CAAC;YACD,IAAI,cAAc,EAAE,CAAC;gBACnB,IAAI,CAAC;oBACH,MAAM,EAAE,CAAC,EAAE,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;gBAC1D,CAAC;gBAAC,OAAO,CAAC,EAAE,CAAC;oBACX,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBACnB,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAY,WAAW;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;IAClD,CAAC;IAEO,KAAK,CAAC,oBAAoB;QAChC,MAAM,gBAAgB,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,qBAAqB,CAAC,CAAC;QAC5E,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,CAAC;QAC1E,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1B,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAa,CAAC;QACzC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,mBAAmB,gBAAgB,GAAG,EAAE,KAAK,CAAC,CAAC;YAC7D,OAAO,EAAE,CAAC;QACZ,CAAC;IACH,CAAC;CACF;AAED,MAAM,qBAAqB,GAAG,mBAAmB,CAAC"}

package/dist/doc_comment_parser.d.ts

@@ -0,0 +1,6 @@
+import type { Doc, MutableDoc, Result, Token } from "skir-internal";
+export declare function parseDocComment(docComment: Token, completionMode?: {
+    position: number;
+}): Result<Doc>;
+export declare function mergeDocs(docs: readonly Doc[]): MutableDoc;
+//# sourceMappingURL=doc_comment_parser.d.ts.map

package/dist/doc_comment_parser.js

@@ -0,0 +1,269 @@
+export function parseDocComment(docComment, completionMode) {
+    const parser = new DocCommentParser(docComment, completionMode);
+    return parser.parse();
+}
+class DocCommentParser {
+    constructor(docComment, completionMode) {
+        this.docComment = docComment;
+        this.completionMode = completionMode;
+        this.pieces = [];
+        this.errors = [];
+        this.currentText = "";
+        this.charIndex = -1;
+        const { text } = docComment;
+        if (text.startsWith("/// ")) {
+            this.content = text.slice(4);
+        }
+        else if (text.startsWith("///")) {
+            this.content = text.slice(3);
+        }
+        else {
+            throw new Error("Expected doc comment to start with ///");
+        }
+        this.charIndex = 0;
+    }
+    parse() {
+        this.parseDocComment();
+        // Add any remaining text
+        if (this.currentText.length > 0) {
+            this.pieces.push({ kind: "text", text: this.currentText });
+        }
+        const { pieces } = this;
+        const text = pieces
+            .map((p) => {
+            switch (p.kind) {
+                case "text":
+                    return p.text;
+                case "reference":
+                    return p.referenceRange.text;
+            }
+        })
+            .join("");
+        return {
+            result: {
+                text: text,
+                pieces: this.pieces,
+            },
+            errors: this.errors,
+        };
+    }
+    parseDocComment() {
+        // 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++;
+            }
+        }
+    }
+    parseReference() {
+        const { content, docComment } = this;
+        const leftBracketCharIndex = this.charIndex;
+        const contentOffset = docComment.text.length - content.length;
+        const startPosition = docComment.position + contentOffset + 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 contentOffset = docComment.text.length - content.length;
+            const position = docComment.position + contentOffset + 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 contentOffset = docComment.text.length - content.length;
+                const column = this.docComment.colNumber + contentOffset + this.charIndex;
+                hasError = true;
+                this.errors.push({
+                    token: referenceRange,
+                    message: `Invalid character in reference at column ${column + 1}`,
+                });
+                // Exit loop
+                this.charIndex = endCharIndex;
+            }
+        }
+        if (!hasError && this.completionMode) {
+            const { position } = this.completionMode;
+            const refAbsoluteStart = startPosition;
+            const refAbsoluteEnd = docComment.position + contentOffset + endCharIndex;
+            if (position >= refAbsoluteStart && position < refAbsoluteEnd) {
+                const inExistingWord = tokens.some((t) => {
+                    return (/^[a-zA-Z]/.test(t.text) &&
+                        position >= t.position &&
+                        position <= t.position + t.text.length);
+                });
+                if (!inExistingWord) {
+                    const fakeToken = {
+                        text: "...",
+                        originalText: "",
+                        position: position,
+                        line: docComment.line,
+                        colNumber: position - docComment.line.position,
+                    };
+                    const insertIndex = tokens.findIndex((t) => t.position >= position);
+                    if (insertIndex === -1) {
+                        tokens.push(fakeToken);
+                    }
+                    else {
+                        tokens.splice(insertIndex, 0, fakeToken);
+                    }
+                }
+            }
+        }
+        const nameParts = hasError ? [] : this.parseNameParts(tokens);
+        return {
+            kind: "reference",
+            nameParts: nameParts,
+            absolute: tokens[0]?.text === ".",
+            referee: undefined,
+            docComment: this.docComment,
+            referenceRange: referenceRange,
+        };
+    }
+    parseNameParts(tokens) {
+        const nameParts = [];
+        let expect = "identifier or '.'";
+        for (const token of tokens) {
+            let expected;
+            if (/^[a-zA-Z]/.test(token.text) || token.text === "...") {
+                // Identifier token or fake completion token.
+                expected = expect === "identifier or '.'" || expect === "identifier";
+                expect = "'.' or ']'";
+                nameParts.push({
+                    token: token,
+                    declaration: undefined,
+                });
+            }
+            else if (token.text === ".") {
+                expected = expect === "identifier or '.'" || expect === "'.' or ']'";
+                expect = "identifier";
+            }
+            else {
+                if (token.text !== "]") {
+                    throw new Error(`Unexpected token in doc reference: ${token.text}`);
+                }
+                expected = expect === "'.' or ']'";
+            }
+            if (!expected) {
+                this.errors.push({
+                    token: token,
+                    expected: expect,
+                });
+                return [];
+            }
+            if (token.text === "]") {
+                return nameParts;
+            }
+        }
+        // An error has already been pushed to signify the unterminated reference.
+        return [];
+    }
+}
+export function mergeDocs(docs) {
+    if (docs.length <= 0) {
+        return EMPTY_DOC;
+    }
+    // Insert '\n' between each doc comment (== line)
+    const text = docs.map((d) => d.text).join("\n");
+    const pieces = [];
+    for (let i = 0; i < docs.length; ++i) {
+        const doc = docs[i];
+        if (i !== 0) {
+            pieces.push({
+                kind: "text",
+                text: "\n",
+            });
+        }
+        doc.pieces.forEach((p) => pieces.push(p));
+    }
+    return {
+        text: text,
+        pieces: pieces,
+    };
+}
+const EMPTY_DOC = Object.freeze({
+    text: "",
+    pieces: Object.freeze([]),
+});
+//# 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,MAAM,UAAU,eAAe,CAC7B,UAAiB,EACjB,cAAqC;IAErC,MAAM,MAAM,GAAG,IAAI,gBAAgB,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;IAChE,OAAO,MAAM,CAAC,KAAK,EAAE,CAAC;AACxB,CAAC;AAED,MAAM,gBAAgB;IAOpB,YACmB,UAAiB,EACjB,cAAqC;QADrC,eAAU,GAAV,UAAU,CAAO;QACjB,mBAAc,GAAd,cAAc,CAAuB;QARvC,WAAM,GAAe,EAAE,CAAC;QACxB,WAAM,GAAgB,EAAE,CAAC;QAClC,gBAAW,GAAG,EAAE,CAAC;QACjB,cAAS,GAAG,CAAC,CAAC,CAAC;QAOrB,MAAM,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC;QAC5B,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;YAC5B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC/B,CAAC;aAAM,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;YAClC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC/B,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAC5D,CAAC;QACD,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;IACrB,CAAC;IAED,KAAK;QACH,IAAI,CAAC,eAAe,EAAE,CAAC;QAEvB,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,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QACxB,MAAM,IAAI,GAAG,MAAM;aAChB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YACT,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;gBACf,KAAK,MAAM;oBACT,OAAO,CAAC,CAAC,IAAI,CAAC;gBAChB,KAAK,WAAW;oBACd,OAAO,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC;YACjC,CAAC;QACH,CAAC,CAAC;aACD,IAAI,CAAC,EAAE,CAAC,CAAC;QAEZ,OAAO;YACL,MAAM,EAAE;gBACN,IAAI,EAAE,IAAI;gBACV,MAAM,EAAE,IAAI,CAAC,MAAM;aACpB;YACD,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,CAAC;IACJ,CAAC;IAEO,eAAe;QACrB,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;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,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC9D,MAAM,aAAa,GACjB,UAAU,CAAC,QAAQ,GAAG,aAAa,GAAG,oBAAoB,CAAC;QAE7D,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,aAAa,GAAG,UAAU,CAAC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;YAC9D,MAAM,QAAQ,GAAG,UAAU,CAAC,QAAQ,GAAG,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC;YAEtE,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,aAAa,GAAG,UAAU,CAAC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;gBAC9D,MAAM,MAAM,GACV,IAAI,CAAC,UAAU,CAAC,SAAS,GAAG,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC;gBAC7D,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,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACrC,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,cAAc,CAAC;YACzC,MAAM,gBAAgB,GAAG,aAAa,CAAC;YACvC,MAAM,cAAc,GAAG,UAAU,CAAC,QAAQ,GAAG,aAAa,GAAG,YAAY,CAAC;YAC1E,IAAI,QAAQ,IAAI,gBAAgB,IAAI,QAAQ,GAAG,cAAc,EAAE,CAAC;gBAC9D,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;oBACvC,OAAO,CACL,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;wBACxB,QAAQ,IAAI,CAAC,CAAC,QAAQ;wBACtB,QAAQ,IAAI,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,CACvC,CAAC;gBACJ,CAAC,CAAC,CAAC;gBACH,IAAI,CAAC,cAAc,EAAE,CAAC;oBACpB,MAAM,SAAS,GAAU;wBACvB,IAAI,EAAE,KAAK;wBACX,YAAY,EAAE,EAAE;wBAChB,QAAQ,EAAE,QAAQ;wBAClB,IAAI,EAAE,UAAU,CAAC,IAAI;wBACrB,SAAS,EAAE,QAAQ,GAAG,UAAU,CAAC,IAAI,CAAC,QAAQ;qBAC/C,CAAC;oBACF,MAAM,WAAW,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,IAAI,QAAQ,CAAC,CAAC;oBACpE,IAAI,WAAW,KAAK,CAAC,CAAC,EAAE,CAAC;wBACvB,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;oBACzB,CAAC;yBAAM,CAAC;wBACN,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,EAAE,SAAS,CAAC,CAAC;oBAC3C,CAAC;gBACH,CAAC;YACH,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,CACpB,MAAwB;QAExB,MAAM,SAAS,GAA8B,EAAE,CAAC;QAChD,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,IAAI,KAAK,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;gBACzD,6CAA6C;gBAC7C,QAAQ,GAAG,MAAM,KAAK,mBAAmB,IAAI,MAAM,KAAK,YAAY,CAAC;gBACrE,MAAM,GAAG,YAAY,CAAC;gBACtB,SAAS,CAAC,IAAI,CAAC;oBACb,KAAK,EAAE,KAAK;oBACZ,WAAW,EAAE,SAAS;iBACvB,CAAC,CAAC;YACL,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,IAAI,KAAK,CAAC,IAAI,KAAK,GAAG,EAAE,CAAC;oBACvB,MAAM,IAAI,KAAK,CAAC,sCAAsC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;gBACtE,CAAC;gBACD,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;CACF;AAED,MAAM,UAAU,SAAS,CAAC,IAAoB;IAC5C,IAAI,IAAI,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;QACrB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,iDAAiD;IACjD,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChD,MAAM,MAAM,GAAsB,EAAE,CAAC;IACrC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;QACrC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAE,CAAC;QACrB,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YACZ,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE,IAAI;aACX,CAAC,CAAC;QACL,CAAC;QACD,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5C,CAAC;IACD,OAAO;QACL,IAAI,EAAE,IAAI;QACV,MAAM,EAAE,MAAM;KACf,CAAC;AACJ,CAAC;AAED,MAAM,SAAS,GAAQ,MAAM,CAAC,MAAM,CAAC;IACnC,IAAI,EAAE,EAAE;IACR,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;CAC1B,CAAC,CAAC"}

package/dist/doc_reference_resolver.d.ts

@@ -0,0 +1,5 @@
+import { ErrorSink, Module, MutableConstant, MutableMethod, MutableRecord, MutableRecordField, RecordKey, RecordLocation } from "skir-internal";
+export type Documentee = MutableConstant | MutableMethod | MutableRecord | MutableRecordField;
+/** Resolve the references in the doc comments of the given declaration. */
+export declare function resolveDocReferences(documentee: Documentee, docModule: Module, getModule: (modulePath: string) => Module | undefined, recordMap: ReadonlyMap<RecordKey, RecordLocation>, errors: ErrorSink): void;
+//# sourceMappingURL=doc_reference_resolver.d.ts.map

package/dist/doc_reference_resolver.js

@@ -0,0 +1,232 @@
+import { declarationsToExpectedNames, ExpectedNamesCollector, } from "./expected_names.js";
+/** Resolve the references in the doc comments of the given declaration. */
+export function resolveDocReferences(documentee, docModule, getModule, recordMap, errors) {
+    const doc = documentee.kind === "field" ? documentee.field.doc : documentee.doc;
+    const docReferences = doc.pieces.filter((p) => p.kind === "reference");
+    if (docReferences.length <= 0) {
+        return;
+    }
+    // Build list of naming scopes to search, in order of priority.
+    const scopes = buildScopes(documentee, docModule, recordMap);
+    // Resolve each reference by searching through scopes in priority order.
+    for (const reference of docReferences) {
+        resolveReferenceInScopes(reference, scopes, docModule, getModule, errors);
+    }
+}
+function buildScopes(documentee, docModule, recordMap) {
+    const scopes = [];
+    const pushRecordAncestorsToScopes = (record) => {
+        const { key } = record;
+        const location = recordMap.get(key);
+        const ancestors = [...location.recordAncestors].reverse();
+        for (const ancestor of ancestors) {
+            scopes.push(ancestor);
+        }
+    };
+    const pushTypeToScopes = (type) => {
+        if (type) {
+            const recordKey = tryFindRecordForType(type);
+            if (recordKey) {
+                const { record } = recordMap.get(recordKey);
+                scopes.push(record);
+            }
+        }
+    };
+    switch (documentee.kind) {
+        case "constant": {
+            scopes.push(docModule);
+            pushTypeToScopes(documentee.type);
+            break;
+        }
+        case "field": {
+            const { field, record } = documentee;
+            pushRecordAncestorsToScopes(record);
+            scopes.push(docModule);
+            pushTypeToScopes(field.type);
+            break;
+        }
+        case "method": {
+            scopes.push(docModule);
+            pushTypeToScopes(documentee.requestType);
+            pushTypeToScopes(documentee.responseType);
+            break;
+        }
+        case "record": {
+            pushRecordAncestorsToScopes(documentee);
+            scopes.push(docModule);
+            break;
+        }
+    }
+    return scopes;
+}
+function resolveReferenceInScopes(reference, scopes, docModule, getModule, errors) {
+    const { nameParts } = reference;
+    if (nameParts.length <= 0) {
+        return;
+    }
+    const expectedNamesCollector = new ExpectedNamesCollector();
+    for (const scope of scopes) {
+        if (reference.absolute && scope !== docModule) {
+            continue;
+        }
+        const referee = tryResolveReference(nameParts, scope, docModule, getModule);
+        if (referee.kind === "no-match") {
+            expectedNamesCollector.collect(referee.expectedNames);
+            // Try the next scope.
+        }
+        else if (referee.kind === "failed-match") {
+            if (referee.error) {
+                errors.push(referee.error);
+            }
+            // Don't try the next scope.
+            return;
+        }
+        else {
+            reference.referee = referee;
+            return;
+        }
+    }
+    // No match in any scope. Report an error on the first name part.
+    const firstName = nameParts[0].token;
+    errors.push({
+        token: firstName,
+        message: "Not found",
+        expectedNames: expectedNamesCollector.expectedNames,
+    });
+}
+// Try to resolve a reference by looking it up in the given scope.
+function tryResolveReference(nameParts, scope, docModule, getModule) {
+    let firstNameMatched = false;
+    for (let i = 0; i < nameParts.length; i++) {
+        const namePart = nameParts[i];
+        const match = scope.nameToDeclaration[namePart.token.text];
+        if (!match) {
+            const expectedNames = declarationsToExpectedNames(scope.nameToDeclaration, (d) => scope === docModule ||
+                (d.kind !== "import" && d.kind !== "import-alias"));
+            if (firstNameMatched) {
+                return {
+                    kind: "failed-match",
+                    error: {
+                        token: namePart.token,
+                        message: "Not found",
+                        expectedNames: expectedNames,
+                    },
+                };
+            }
+            else {
+                return {
+                    kind: "no-match",
+                    expectedNames: expectedNames,
+                };
+            }
+        }
+        firstNameMatched = true;
+        const isLastPart = i === nameParts.length - 1;
+        const makeExpectedToBeLastNameFailedMatch = () => ({
+            kind: "failed-match",
+            error: {
+                token: namePart.token,
+                message: "Expected to be the last name in the sequence",
+            },
+        });
+        switch (match.kind) {
+            case "constant":
+            case "method": {
+                namePart.declaration = match;
+                if (isLastPart) {
+                    return match;
+                }
+                else {
+                    return makeExpectedToBeLastNameFailedMatch();
+                }
+            }
+            case "record": {
+                scope = match;
+                namePart.declaration = match;
+                if (isLastPart) {
+                    return match;
+                }
+                else {
+                    break;
+                }
+            }
+            case "field": {
+                namePart.declaration = match;
+                if (isLastPart) {
+                    return {
+                        kind: "field",
+                        field: match,
+                        record: scope,
+                    };
+                }
+                else {
+                    return makeExpectedToBeLastNameFailedMatch();
+                }
+            }
+            case "import-alias": {
+                if (isLastPart) {
+                    return {
+                        kind: "failed-match",
+                        error: {
+                            token: namePart.token,
+                            message: "Cannot be the last name in the sequence",
+                        },
+                    };
+                }
+                // Falls through
+            }
+            case "import": {
+                if (scope !== docModule) {
+                    // Cannot refer to other module's imports.
+                    return {
+                        kind: "failed-match",
+                        error: {
+                            token: namePart.token,
+                            message: "Cannot refer to other module's imports",
+                        },
+                    };
+                }
+                const { resolvedModulePath } = match;
+                if (!resolvedModulePath) {
+                    return {
+                        kind: "failed-match",
+                        error: null, // An error has already been registered
+                    };
+                }
+                const importedModule = getModule(resolvedModulePath);
+                if (!importedModule) {
+                    return {
+                        kind: "failed-match",
+                        error: null, // An error has already been registered
+                    };
+                }
+                scope = importedModule;
+                if (match.kind === "import") {
+                    // Rewind to this name part, but with the imported module as scope.
+                    --i;
+                }
+                else {
+                    namePart.declaration = match;
+                }
+                break;
+            }
+            case "removed": {
+                throw new TypeError();
+            }
+        }
+    }
+    throw new Error("Unreachable");
+}
+function tryFindRecordForType(type) {
+    switch (type.kind) {
+        case "array":
+            return tryFindRecordForType(type.item);
+        case "optional":
+            return tryFindRecordForType(type.other);
+        case "record":
+            return type.key;
+        case "primitive":
+            return null;
+    }
+}
+//# sourceMappingURL=doc_reference_resolver.js.map

package/dist/doc_reference_resolver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"doc_reference_resolver.js","sourceRoot":"","sources":["../src/doc_reference_resolver.ts"],"names":[],"mappings":"AAoBA,OAAO,EACL,2BAA2B,EAC3B,sBAAsB,GACvB,MAAM,qBAAqB,CAAC;AAQ7B,2EAA2E;AAC3E,MAAM,UAAU,oBAAoB,CAClC,UAAsB,EACtB,SAAiB,EACjB,SAAqD,EACrD,SAAiD,EACjD,MAAiB;IAEjB,MAAM,GAAG,GACP,UAAU,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC;IAEtE,MAAM,aAAa,GAAG,GAAG,CAAC,MAAM,CAAC,MAAM,CACrC,CAAC,CAAC,EAA4B,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,WAAW,CACxD,CAAC;IACF,IAAI,aAAa,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;QAC9B,OAAO;IACT,CAAC;IAED,+DAA+D;IAC/D,MAAM,MAAM,GAAG,WAAW,CAAC,UAAU,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;IAE7D,wEAAwE;IACxE,KAAK,MAAM,SAAS,IAAI,aAAa,EAAE,CAAC;QACtC,wBAAwB,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IAC5E,CAAC;AACH,CAAC;AAED,SAAS,WAAW,CAClB,UAAsB,EACtB,SAAiB,EACjB,SAAiD;IAEjD,MAAM,MAAM,GAA2B,EAAE,CAAC;IAC1C,MAAM,2BAA2B,GAAG,CAAC,MAAc,EAAQ,EAAE;QAC3D,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC;QACvB,MAAM,QAAQ,GAAG,SAAS,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC;QACrC,MAAM,SAAS,GAAG,CAAC,GAAG,QAAQ,CAAC,eAAe,CAAC,CAAC,OAAO,EAAE,CAAC;QAC1D,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YACjC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACxB,CAAC;IACH,CAAC,CAAC;IACF,MAAM,gBAAgB,GAAG,CAAC,IAA8B,EAAQ,EAAE;QAChE,IAAI,IAAI,EAAE,CAAC;YACT,MAAM,SAAS,GAAG,oBAAoB,CAAC,IAAI,CAAC,CAAC;YAC7C,IAAI,SAAS,EAAE,CAAC;gBACd,MAAM,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC,GAAG,CAAC,SAAS,CAAE,CAAC;gBAC7C,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACtB,CAAC;QACH,CAAC;IACH,CAAC,CAAC;IACF,QAAQ,UAAU,CAAC,IAAI,EAAE,CAAC;QACxB,KAAK,UAAU,CAAC,CAAC,CAAC;YAChB,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACvB,gBAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;YAClC,MAAM;QACR,CAAC;QACD,KAAK,OAAO,CAAC,CAAC,CAAC;YACb,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC;YACrC,2BAA2B,CAAC,MAAM,CAAC,CAAC;YACpC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACvB,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC7B,MAAM;QACR,CAAC;QACD,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACvB,gBAAgB,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;YACzC,gBAAgB,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;YAC1C,MAAM;QACR,CAAC;QACD,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,2BAA2B,CAAC,UAAU,CAAC,CAAC;YACxC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACvB,MAAM;QACR,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,wBAAwB,CAC/B,SAA8B,EAC9B,MAAsC,EACtC,SAAiB,EACjB,SAAqD,EACrD,MAAiB;IAEjB,MAAM,EAAE,SAAS,EAAE,GAAG,SAAS,CAAC;IAChC,IAAI,SAAS,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;QAC1B,OAAO;IACT,CAAC;IACD,MAAM,sBAAsB,GAAG,IAAI,sBAAsB,EAAE,CAAC;IAC5D,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,IAAI,SAAS,CAAC,QAAQ,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YAC9C,SAAS;QACX,CAAC;QACD,MAAM,OAAO,GAAG,mBAAmB,CAAC,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;QAC5E,IAAI,OAAO,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YAChC,sBAAsB,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;YACtD,sBAAsB;QACxB,CAAC;aAAM,IAAI,OAAO,CAAC,IAAI,KAAK,cAAc,EAAE,CAAC;YAC3C,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;gBAClB,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAC7B,CAAC;YACD,4BAA4B;YAC5B,OAAO;QACT,CAAC;aAAM,CAAC;YACN,SAAS,CAAC,OAAO,GAAG,OAAO,CAAC;YAC5B,OAAO;QACT,CAAC;IACH,CAAC;IACD,iEAAiE;IACjE,MAAM,SAAS,GAAG,SAAS,CAAC,CAAC,CAAE,CAAC,KAAK,CAAC;IACtC,MAAM,CAAC,IAAI,CAAC;QACV,KAAK,EAAE,SAAS;QAChB,OAAO,EAAE,WAAW;QACpB,aAAa,EAAE,sBAAsB,CAAC,aAAa;KACpD,CAAC,CAAC;AACL,CAAC;AAaD,kEAAkE;AAClE,SAAS,mBAAmB,CAC1B,SAA6C,EAC7C,KAAsB,EACtB,SAAiB,EACjB,SAAqD;IAErD,IAAI,gBAAgB,GAAG,KAAK,CAAC;IAC7B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1C,MAAM,QAAQ,GAAG,SAAS,CAAC,CAAC,CAAE,CAAC;QAC/B,MAAM,KAAK,GAAG,KAAK,CAAC,iBAAiB,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC3D,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,aAAa,GAAG,2BAA2B,CAC/C,KAAK,CAAC,iBAAiB,EACvB,CAAC,CAAC,EAAE,EAAE,CACJ,KAAK,KAAK,SAAS;gBACnB,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,CAAC,IAAI,KAAK,cAAc,CAAC,CACrD,CAAC;YACF,IAAI,gBAAgB,EAAE,CAAC;gBACrB,OAAO;oBACL,IAAI,EAAE,cAAc;oBACpB,KAAK,EAAE;wBACL,KAAK,EAAE,QAAQ,CAAC,KAAK;wBACrB,OAAO,EAAE,WAAW;wBACpB,aAAa,EAAE,aAAa;qBAC7B;iBACF,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,OAAO;oBACL,IAAI,EAAE,UAAU;oBAChB,aAAa,EAAE,aAAa;iBAC7B,CAAC;YACJ,CAAC;QACH,CAAC;QACD,gBAAgB,GAAG,IAAI,CAAC;QACxB,MAAM,UAAU,GAAG,CAAC,KAAK,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;QAC9C,MAAM,mCAAmC,GAAG,GAAgB,EAAE,CAAC,CAAC;YAC9D,IAAI,EAAE,cAAc;YACpB,KAAK,EAAE;gBACL,KAAK,EAAE,QAAQ,CAAC,KAAK;gBACrB,OAAO,EAAE,8CAA8C;aACxD;SACF,CAAC,CAAC;QACH,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,UAAU,CAAC;YAChB,KAAK,QAAQ,CAAC,CAAC,CAAC;gBACd,QAAQ,CAAC,WAAW,GAAG,KAAK,CAAC;gBAC7B,IAAI,UAAU,EAAE,CAAC;oBACf,OAAO,KAAK,CAAC;gBACf,CAAC;qBAAM,CAAC;oBACN,OAAO,mCAAmC,EAAE,CAAC;gBAC/C,CAAC;YACH,CAAC;YACD,KAAK,QAAQ,CAAC,CAAC,CAAC;gBACd,KAAK,GAAG,KAAK,CAAC;gBACd,QAAQ,CAAC,WAAW,GAAG,KAAK,CAAC;gBAC7B,IAAI,UAAU,EAAE,CAAC;oBACf,OAAO,KAAK,CAAC;gBACf,CAAC;qBAAM,CAAC;oBACN,MAAM;gBACR,CAAC;YACH,CAAC;YACD,KAAK,OAAO,CAAC,CAAC,CAAC;gBACb,QAAQ,CAAC,WAAW,GAAG,KAAK,CAAC;gBAC7B,IAAI,UAAU,EAAE,CAAC;oBACf,OAAO;wBACL,IAAI,EAAE,OAAO;wBACb,KAAK,EAAE,KAAK;wBACZ,MAAM,EAAE,KAAe;qBACxB,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACN,OAAO,mCAAmC,EAAE,CAAC;gBAC/C,CAAC;YACH,CAAC;YACD,KAAK,cAAc,CAAC,CAAC,CAAC;gBACpB,IAAI,UAAU,EAAE,CAAC;oBACf,OAAO;wBACL,IAAI,EAAE,cAAc;wBACpB,KAAK,EAAE;4BACL,KAAK,EAAE,QAAQ,CAAC,KAAK;4BACrB,OAAO,EAAE,yCAAyC;yBACnD;qBACF,CAAC;gBACJ,CAAC;gBACD,gBAAgB;YAClB,CAAC;YACD,KAAK,QAAQ,CAAC,CAAC,CAAC;gBACd,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;oBACxB,0CAA0C;oBAC1C,OAAO;wBACL,IAAI,EAAE,cAAc;wBACpB,KAAK,EAAE;4BACL,KAAK,EAAE,QAAQ,CAAC,KAAK;4BACrB,OAAO,EAAE,wCAAwC;yBAClD;qBACF,CAAC;gBACJ,CAAC;gBACD,MAAM,EAAE,kBAAkB,EAAE,GAAG,KAAK,CAAC;gBACrC,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBACxB,OAAO;wBACL,IAAI,EAAE,cAAc;wBACpB,KAAK,EAAE,IAAI,EAAE,uCAAuC;qBACrD,CAAC;gBACJ,CAAC;gBACD,MAAM,cAAc,GAAG,SAAS,CAAC,kBAAmB,CAAC,CAAC;gBACtD,IAAI,CAAC,cAAc,EAAE,CAAC;oBACpB,OAAO;wBACL,IAAI,EAAE,cAAc;wBACpB,KAAK,EAAE,IAAI,EAAE,uCAAuC;qBACrD,CAAC;gBACJ,CAAC;gBACD,KAAK,GAAG,cAAc,CAAC;gBACvB,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;oBAC5B,mEAAmE;oBACnE,EAAE,CAAC,CAAC;gBACN,CAAC;qBAAM,CAAC;oBACN,QAAQ,CAAC,WAAW,GAAG,KAAK,CAAC;gBAC/B,CAAC;gBACD,MAAM;YACR,CAAC;YACD,KAAK,SAAS,CAAC,CAAC,CAAC;gBACf,MAAM,IAAI,SAAS,EAAE,CAAC;YACxB,CAAC;QACH,CAAC;IACH,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC;AACjC,CAAC;AAED,SAAS,oBAAoB,CAAC,IAAkB;IAC9C,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,OAAO;YACV,OAAO,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzC,KAAK,UAAU;YACb,OAAO,oBAAoB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC1C,KAAK,QAAQ;YACX,OAAO,IAAI,CAAC,GAAG,CAAC;QAClB,KAAK,WAAW;YACd,OAAO,IAAI,CAAC;IAChB,CAAC;AACH,CAAC"}