@typespec/tspd 0.47.0-dev.0

package/LICENSE

@@ -0,0 +1,21 @@
+    MIT License
+
+    Copyright (c) Microsoft Corporation. All rights reserved.
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE

package/cmd/tspd.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import "../dist/src/cli.js";

package/dist/src/cli.d.ts

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

package/dist/src/cli.d.ts.map

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

package/dist/src/cli.js

@@ -0,0 +1,99 @@
+/* eslint-disable no-console */
+import { NodeHost, logDiagnostics, resolvePath, typespecVersion } from "@typespec/compiler";
+import pc from "picocolors";
+import yargs from "yargs";
+import { generateLibraryDocs } from "./ref-doc/experimental.js";
+try {
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    await import("source-map-support/register.js");
+}
+catch {
+    // package only present in dev.
+}
+function logExperimentalWarning(type) {
+    const log = type === "error"
+        ? (message) => console.error(pc.red(message))
+        : (message) => console.log(pc.yellow(message));
+    log("-".repeat(100));
+    log(`tspd (TypeSpec Library Developer Cli) is experimental and might be ${pc.bold("BREAKING")} between versions.`);
+    if (type === "error") {
+        log(`Add "--enable-experimental" flag to acknowledge this and continue.`);
+    }
+    log("-".repeat(100));
+}
+async function main() {
+    console.log(`TypeSpec Developer Tools v${typespecVersion}\n`);
+    await yargs(process.argv.slice(2))
+        .scriptName("tspd")
+        .help()
+        .strict()
+        .parserConfiguration({
+        "greedy-arrays": false,
+        "boolean-negation": false,
+    })
+        .option("debug", {
+        type: "boolean",
+        description: "Output debug log messages.",
+        default: false,
+    })
+        .option("pretty", {
+        type: "boolean",
+        description: "Enable color and formatting in TypeSpec's output to make compiler errors easier to read.",
+        default: true,
+    })
+        .option("enable-experimental", {
+        type: "boolean",
+        description: "Acknowledge that the tspd command line is experiemental.",
+        default: false,
+    })
+        .check((args) => {
+        if (args["enable-experimental"]) {
+            logExperimentalWarning("log");
+            return true;
+        }
+        else {
+            logExperimentalWarning("error");
+            process.exit(1);
+        }
+    })
+        .command("doc <entrypoint>", "Generate documentation for a TypeSpec library.", (cmd) => {
+        return cmd
+            .positional("entrypoint", {
+            description: "Path to the library entrypoint.",
+            type: "string",
+            demandOption: true,
+        })
+            .option("output-dir", {
+            type: "string",
+        });
+    }, async (args) => {
+        var _a;
+        const resolvedRoot = resolvePath(process.cwd(), args.entrypoint);
+        const host = NodeHost;
+        const diagnostics = await generateLibraryDocs(resolvedRoot, (_a = args["output-dir"]) !== null && _a !== void 0 ? _a : resolvePath(resolvedRoot, "docs"));
+        // const diagnostics = await generateExternSignatures(host, resolvedRoot);
+        if (diagnostics.length > 0) {
+            logDiagnostics(diagnostics, host.logSink);
+        }
+    })
+        .version(typespecVersion)
+        .demandCommand(1, "You must use one of the supported commands.").argv;
+}
+function internalError(error) {
+    // NOTE: An expected error, like one thrown for bad input, shouldn't reach
+    // here, but be handled somewhere else. If we reach here, it should be
+    // considered a bug and therefore we should not suppress the stack trace as
+    // that risks losing it in the case of a bug that does not repro easily.
+    console.error("Internal error!");
+    console.error("File issue at https://github.com/microsoft/typespec");
+    console.error();
+    console.error(error);
+    process.exit(1);
+}
+process.on("unhandledRejection", (error) => {
+    console.error("Unhandled promise rejection!");
+    internalError(error);
+});
+main().catch(internalError);
+//# sourceMappingURL=cli.js.map

package/dist/src/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../src/cli.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAC5F,OAAO,EAAE,MAAM,YAAY,CAAC;AAC5B,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAEhE,IAAI,CAAC;IACH,6DAA6D;IAC7D,aAAa;IACb,MAAM,MAAM,CAAC,gCAAgC,CAAC,CAAC;AACjD,CAAC;AAAC,MAAM,CAAC;IACP,+BAA+B;AACjC,CAAC;AAED,SAAS,sBAAsB,CAAC,IAAqB;IACnD,MAAM,GAAG,GACP,IAAI,KAAK,OAAO;QACd,CAAC,CAAC,CAAC,OAAe,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACrD,CAAC,CAAC,CAAC,OAAe,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;IAC3D,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IACrB,GAAG,CACD,sEAAsE,EAAE,CAAC,IAAI,CAC3E,UAAU,CACX,oBAAoB,CACtB,CAAC;IACF,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;QACrB,GAAG,CAAC,oEAAoE,CAAC,CAAC;IAC5E,CAAC;IACD,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;AACvB,CAAC;AAED,KAAK,UAAU,IAAI;IACjB,OAAO,CAAC,GAAG,CAAC,6BAA6B,eAAe,IAAI,CAAC,CAAC;IAE9D,MAAM,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAC/B,UAAU,CAAC,MAAM,CAAC;SAClB,IAAI,EAAE;SACN,MAAM,EAAE;SACR,mBAAmB,CAAC;QACnB,eAAe,EAAE,KAAK;QACtB,kBAAkB,EAAE,KAAK;KAC1B,CAAC;SACD,MAAM,CAAC,OAAO,EAAE;QACf,IAAI,EAAE,SAAS;QACf,WAAW,EAAE,4BAA4B;QACzC,OAAO,EAAE,KAAK;KACf,CAAC;SACD,MAAM,CAAC,QAAQ,EAAE;QAChB,IAAI,EAAE,SAAS;QACf,WAAW,EACT,0FAA0F;QAC5F,OAAO,EAAE,IAAI;KACd,CAAC;SACD,MAAM,CAAC,qBAAqB,EAAE;QAC7B,IAAI,EAAE,SAAS;QACf,WAAW,EAAE,0DAA0D;QACvE,OAAO,EAAE,KAAK;KACf,CAAC;SACD,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE;QACd,IAAI,IAAI,CAAC,qBAAqB,CAAC,EAAE,CAAC;YAChC,sBAAsB,CAAC,KAAK,CAAC,CAAC;YAC9B,OAAO,IAAI,CAAC;QACd,CAAC;aAAM,CAAC;YACN,sBAAsB,CAAC,OAAO,CAAC,CAAC;YAChC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;IACH,CAAC,CAAC;SACD,OAAO,CACN,kBAAkB,EAClB,gDAAgD,EAChD,CAAC,GAAG,EAAE,EAAE;QACN,OAAO,GAAG;aACP,UAAU,CAAC,YAAY,EAAE;YACxB,WAAW,EAAE,iCAAiC;YAC9C,IAAI,EAAE,QAAQ;YACd,YAAY,EAAE,IAAI;SACnB,CAAC;aACD,MAAM,CAAC,YAAY,EAAE;YACpB,IAAI,EAAE,QAAQ;SACf,CAAC,CAAC;IACP,CAAC,EACD,KAAK,EAAE,IAAI,EAAE,EAAE;;QACb,MAAM,YAAY,GAAG,WAAW,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACjE,MAAM,IAAI,GAAG,QAAQ,CAAC;QACtB,MAAM,WAAW,GAAG,MAAM,mBAAmB,CAC3C,YAAY,EACZ,MAAA,IAAI,CAAC,YAAY,CAAC,mCAAI,WAAW,CAAC,YAAY,EAAE,MAAM,CAAC,CACxD,CAAC;QACF,0EAA0E;QAC1E,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3B,cAAc,CAAC,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC,CACF;SACA,OAAO,CAAC,eAAe,CAAC;SACxB,aAAa,CAAC,CAAC,EAAE,6CAA6C,CAAC,CAAC,IAAI,CAAC;AAC1E,CAAC;AAED,SAAS,aAAa,CAAC,KAAc;IACnC,0EAA0E;IAC1E,sEAAsE;IACtE,2EAA2E;IAC3E,wEAAwE;IAExE,OAAO,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACjC,OAAO,CAAC,KAAK,CAAC,qDAAqD,CAAC,CAAC;IACrE,OAAO,CAAC,KAAK,EAAE,CAAC;IAChB,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAErB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,OAAO,CAAC,EAAE,CAAC,oBAAoB,EAAE,CAAC,KAAc,EAAE,EAAE;IAClD,OAAO,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAC;IAC9C,aAAa,CAAC,KAAK,CAAC,CAAC;AACvB,CAAC,CAAC,CAAC;AAEH,IAAI,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC"}

package/dist/src/ref-doc/api-docs.d.ts

@@ -0,0 +1,4 @@
+import { Application } from "typedoc";
+export declare function generateJsApiDocs(libraryPath: string, outputDir: string): Promise<void>;
+export declare function loadRenderer(app: Application): void;
+//# sourceMappingURL=api-docs.d.ts.map

package/dist/src/ref-doc/api-docs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-docs.d.ts","sourceRoot":"","sources":["../../../src/ref-doc/api-docs.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAoD,MAAM,SAAS,CAAC;AAGxF,wBAAsB,iBAAiB,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,iBAmD7E;AAQD,wBAAgB,YAAY,CAAC,GAAG,EAAE,WAAW,QAO5C"}

package/dist/src/ref-doc/api-docs.js

@@ -0,0 +1,71 @@
+import { joinPaths } from "@typespec/compiler";
+import { writeFile } from "fs/promises";
+import { Application, PageEvent, ReflectionKind } from "typedoc";
+import { load } from "typedoc-plugin-markdown";
+import { stringify } from "yaml";
+export async function generateJsApiDocs(libraryPath, outputDir) {
+    const markdownPluginOptions = {
+        entryFileName: "index.md",
+        propertiesFormat: "table",
+        parametersFormat: "table",
+        enumMembersFormat: "table",
+        typeDeclarationFormat: "table",
+        hidePageTitle: true,
+        hideBreadcrumbs: true,
+        hideInPageTOC: true,
+        hidePageHeader: true,
+        useCodeBlocks: true,
+    };
+    const app = await Application.bootstrapWithPlugins({
+        entryPoints: [joinPaths(libraryPath, "src/index.ts")],
+        tsconfig: joinPaths(libraryPath, "tsconfig.json"),
+        entryPointStrategy: "resolve",
+    });
+    loadRenderer(app);
+    load(app);
+    setOptions(app, {
+        name: "JS API",
+        githubPages: false,
+        readme: "none",
+        hideGenerator: true,
+        disableSources: true,
+        ...markdownPluginOptions,
+    });
+    const project = await app.convert();
+    // if project is undefined typedoc has a problem - error logging will be supplied by typedoc.
+    if (!project) {
+        return;
+    }
+    await app.generateDocs(project, outputDir);
+    await writeFile(joinPaths(outputDir, "_category_.json"), JSON.stringify({
+        label: "JS API",
+        link: {
+            type: "doc",
+            id: "index",
+        },
+    }));
+}
+function setOptions(app, options, reportErrors = true) {
+    for (const [key, val] of Object.entries(options)) {
+        app.options.setValue(key, val);
+    }
+}
+export function loadRenderer(app) {
+    app.renderer.on(PageEvent.END, (page) => {
+        if (page.contents) {
+            const frontMatter = createFrontMatter(page.model);
+            page.contents = frontMatter + page.contents.replace(/\\</g, "<");
+        }
+    });
+}
+function createFrontMatter(model) {
+    return ["---", stringify(createFrontMatterData(model)), "---", ""].join("\n");
+}
+function createFrontMatterData(model) {
+    const kind = ReflectionKind.singularString(model.kind)[0];
+    return {
+        jsApi: true,
+        title: `[${kind}] ${model.name}`,
+    };
+}
+//# sourceMappingURL=api-docs.js.map

package/dist/src/ref-doc/api-docs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-docs.js","sourceRoot":"","sources":["../../../src/ref-doc/api-docs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,WAAW,EAAyB,SAAS,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AACxF,OAAO,EAAiB,IAAI,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AACjC,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,WAAmB,EAAE,SAAiB;IAC5E,MAAM,qBAAqB,GAA2B;QACpD,aAAa,EAAE,UAAU;QACzB,gBAAgB,EAAE,OAAO;QACzB,gBAAgB,EAAE,OAAO;QACzB,iBAAiB,EAAE,OAAO;QAC1B,qBAAqB,EAAE,OAAO;QAC9B,aAAa,EAAE,IAAI;QACnB,eAAe,EAAE,IAAI;QACrB,aAAa,EAAE,IAAI;QACnB,cAAc,EAAE,IAAI;QACpB,aAAa,EAAE,IAAI;KACpB,CAAC;IAEF,MAAM,GAAG,GAAG,MAAM,WAAW,CAAC,oBAAoB,CAAC;QACjD,WAAW,EAAE,CAAC,SAAS,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;QACrD,QAAQ,EAAE,SAAS,CAAC,WAAW,EAAE,eAAe,CAAC;QACjD,kBAAkB,EAAE,SAAS;KAC9B,CAAC,CAAC;IAEH,YAAY,CAAC,GAAG,CAAC,CAAC;IAClB,IAAI,CAAC,GAAG,CAAC,CAAC;IAEV,UAAU,CAAC,GAAG,EAAE;QACd,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,KAAK;QAClB,MAAM,EAAE,MAAM;QACd,aAAa,EAAE,IAAI;QACnB,cAAc,EAAE,IAAI;QACpB,GAAG,qBAAqB;KACzB,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,MAAM,GAAG,CAAC,OAAO,EAAE,CAAC;IAEpC,6FAA6F;IAC7F,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO;IACT,CAAC;IAED,MAAM,GAAG,CAAC,YAAY,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IAE3C,MAAM,SAAS,CACb,SAAS,CAAC,SAAS,EAAE,iBAAiB,CAAC,EACvC,IAAI,CAAC,SAAS,CAAC;QACb,KAAK,EAAE,QAAQ;QACf,IAAI,EAAE;YACJ,IAAI,EAAE,KAAK;YACX,EAAE,EAAE,OAAO;SACZ;KACF,CAAC,CACH,CAAC;AACJ,CAAC;AAED,SAAS,UAAU,CAAC,GAAgB,EAAE,OAAY,EAAE,YAAY,GAAG,IAAI;IACrE,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QACjD,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAY,EAAE,GAAY,CAAC,CAAC;IACnD,CAAC;AACH,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,GAAgB;IAC3C,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,IAAsC,EAAE,EAAE;QACxE,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,MAAM,WAAW,GAAG,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAClD,IAAI,CAAC,QAAQ,GAAG,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACnE,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,iBAAiB,CAAC,KAA4B;IACrD,OAAO,CAAC,KAAK,EAAE,SAAS,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAChF,CAAC;AAED,SAAS,qBAAqB,CAAC,KAA4B;IACzD,MAAM,IAAI,GAAG,cAAc,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAE1D,OAAO;QACL,KAAK,EAAE,IAAI;QACX,KAAK,EAAE,IAAI,IAAI,KAAK,KAAK,CAAC,IAAI,EAAE;KACjC,CAAC;AACJ,CAAC"}

package/dist/src/ref-doc/emitters/docusaurus.d.ts

@@ -0,0 +1,24 @@
+import { NamedTypeRefDoc, TypeSpecLibraryRefDoc, TypeSpecRefDoc, TypeSpecRefDocBase } from "../types.js";
+import { MarkdownSection } from "../utils/markdown.js";
+import { MarkdownRenderer } from "./markdown.js";
+/**
+ * Render doc to a markdown using docusaurus addons.
+ */
+export declare function renderToDocusaurusMarkdown(refDoc: TypeSpecRefDoc): Record<string, string>;
+export type DecoratorRenderOptions = {
+    title?: string;
+};
+export declare function renderDecoratorFile(renderer: DocusaurusRenderer, refDoc: TypeSpecRefDocBase, options?: DecoratorRenderOptions): string | undefined;
+export type DataTypeRenderOptions = {
+    title?: string;
+};
+export declare function renderDataTypes(renderer: DocusaurusRenderer, refDoc: TypeSpecRefDoc, options?: DataTypeRenderOptions): string | undefined;
+export declare class DocusaurusRenderer extends MarkdownRenderer {
+    #private;
+    constructor(refDoc: TypeSpecLibraryRefDoc);
+    headingTitle(item: NamedTypeRefDoc): string;
+    anchorId(item: NamedTypeRefDoc): string;
+    install(refDoc: TypeSpecLibraryRefDoc): MarkdownSection;
+    linterRuleLink(url: string): string;
+}
+//# sourceMappingURL=docusaurus.d.ts.map

package/dist/src/ref-doc/emitters/docusaurus.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"docusaurus.d.ts","sourceRoot":"","sources":["../../../../src/ref-doc/emitters/docusaurus.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EACf,qBAAqB,EACrB,cAAc,EACd,kBAAkB,EACnB,MAAM,aAAa,CAAC;AACrB,OAAO,EAEL,eAAe,EAMhB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,gBAAgB,EAAoB,MAAM,eAAe,CAAC;AAEnE;;GAEG;AACH,wBAAgB,0BAA0B,CAAC,MAAM,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CA+BzF;AAmDD,MAAM,MAAM,sBAAsB,GAAG;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,wBAAgB,mBAAmB,CACjC,QAAQ,EAAE,kBAAkB,EAC5B,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,sBAAsB,GAC/B,MAAM,GAAG,SAAS,CAepB;AAwCD,MAAM,MAAM,qBAAqB,GAAG;IAClC,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,wBAAgB,eAAe,CAC7B,QAAQ,EAAE,kBAAkB,EAC5B,MAAM,EAAE,cAAc,EACtB,OAAO,CAAC,EAAE,qBAAqB,GAC9B,MAAM,GAAG,SAAS,CA4CpB;AAuCD,qBAAa,kBAAmB,SAAQ,gBAAgB;;gBAE1C,MAAM,EAAE,qBAAqB;IAIzC,YAAY,CAAC,IAAI,EAAE,eAAe,GAAG,MAAM;IAI3C,QAAQ,CAAC,IAAI,EAAE,eAAe,GAAG,MAAM;IAKvC,OAAO,CAAC,MAAM,EAAE,qBAAqB,GAAG,eAAe;IAkBvD,cAAc,CAAC,GAAG,EAAE,MAAM;CAS3B"}

package/dist/src/ref-doc/emitters/docusaurus.js

@@ -0,0 +1,232 @@
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _DocusaurusRenderer_refDoc;
+import { codeblock, inlinecode, renderMarkdowDoc, section, tabs, } from "../utils/markdown.js";
+import { MarkdownRenderer, groupByNamespace } from "./markdown.js";
+/**
+ * Render doc to a markdown using docusaurus addons.
+ */
+export function renderToDocusaurusMarkdown(refDoc) {
+    const renderer = new DocusaurusRenderer(refDoc);
+    const files = {
+        "index.mdx": renderIndexFile(renderer, refDoc),
+    };
+    const decoratorFile = renderDecoratorFile(renderer, refDoc);
+    if (decoratorFile) {
+        files["decorators.md"] = decoratorFile;
+    }
+    const interfaceFile = renderInterfacesFile(renderer, refDoc);
+    if (interfaceFile) {
+        files["interfaces.md"] = interfaceFile;
+    }
+    const dataTypes = renderDataTypes(renderer, refDoc);
+    if (dataTypes) {
+        files["data-types.md"] = dataTypes;
+    }
+    const emitter = renderEmitter(renderer, refDoc);
+    if (emitter) {
+        files["emitter.md"] = emitter;
+    }
+    const linter = renderLinter(renderer, refDoc);
+    if (linter) {
+        files["linter.md"] = linter;
+    }
+    return files;
+}
+function renderIndexFile(renderer, refDoc) {
+    var _a, _b;
+    const content = [
+        "---",
+        `title: Overview`,
+        `sidebar_position: 0`,
+        "toc_min_heading_level: 2",
+        "toc_max_heading_level: 3",
+        "---",
+        "import Tabs from '@theme/Tabs';",
+        "import TabItem from '@theme/TabItem';",
+        "",
+        section("Overview", [
+            (_a = refDoc.description) !== null && _a !== void 0 ? _a : [],
+            renderer.install(refDoc),
+            ((_b = refDoc.emitter) === null || _b === void 0 ? void 0 : _b.options) ? section("Emitter usage", `[See documentation](./emitter.md)`) : [],
+            groupByNamespace(refDoc.namespaces, (namespace) => {
+                const content = [];
+                if (namespace.decorators.length > 0) {
+                    content.push(section("Decorators", renderer.toc(namespace.decorators, "./decorators.md")));
+                }
+                if (namespace.interfaces.length > 0) {
+                    content.push(section("Interfaces", renderer.toc(namespace.interfaces, "./interfaces.md")));
+                }
+                if (namespace.operations.length > 0) {
+                    content.push(section("Operations", renderer.toc(namespace.operations, "./interfaces.md")));
+                }
+                if (namespace.models.length > 0) {
+                    content.push(section("Models", renderer.toc(namespace.models, "./data-types.md")));
+                }
+                return content;
+            }),
+        ]),
+    ];
+    return renderMarkdowDoc(content);
+}
+export function renderDecoratorFile(renderer, refDoc, options) {
+    var _a;
+    if (!refDoc.namespaces.some((x) => x.decorators.length > 0)) {
+        return undefined;
+    }
+    const title = (_a = options === null || options === void 0 ? void 0 : options.title) !== null && _a !== void 0 ? _a : "Decorators";
+    const content = [
+        "---",
+        `title: "${title}"`,
+        "toc_min_heading_level: 2",
+        "toc_max_heading_level: 3",
+        "---",
+    ];
+    content.push(section(title, renderer.decoratorsSection(refDoc)));
+    return renderMarkdowDoc(content);
+}
+function renderInterfacesFile(renderer, refDoc) {
+    if (!refDoc.namespaces.some((x) => x.operations.length > 0 || x.interfaces.length > 0)) {
+        return undefined;
+    }
+    const content = [
+        "---",
+        `title: "Interfaces and Operations"`,
+        "toc_min_heading_level: 2",
+        "toc_max_heading_level: 3",
+        "---",
+    ];
+    content.push(section("Interfaces and Operations", [
+        groupByNamespace(refDoc.namespaces, (namespace) => {
+            if (namespace.operations.length === 0 && namespace.interfaces.length === 0) {
+                return undefined;
+            }
+            const content = [];
+            for (const iface of namespace.interfaces) {
+                content.push(renderer.interface(iface), "");
+            }
+            for (const operation of namespace.operations) {
+                content.push(renderer.operation(operation), "");
+            }
+            return content;
+        }),
+    ]));
+    return renderMarkdowDoc(content);
+}
+export function renderDataTypes(renderer, refDoc, options) {
+    var _a;
+    if (!refDoc.namespaces.some((x) => x.models.length > 0)) {
+        return undefined;
+    }
+    const title = (_a = options === null || options === void 0 ? void 0 : options.title) !== null && _a !== void 0 ? _a : "Data types";
+    const content = [
+        "---",
+        `title: "${title}"`,
+        "toc_min_heading_level: 2",
+        "toc_max_heading_level: 3",
+        "---",
+    ];
+    content.push(section("Data types", groupByNamespace(refDoc.namespaces, (namespace) => {
+        const modelCount = namespace.models.length +
+            namespace.enums.length +
+            namespace.unions.length +
+            namespace.scalars.length;
+        if (modelCount === 0) {
+            return undefined;
+        }
+        const content = [];
+        for (const model of namespace.models) {
+            content.push(renderer.model(model), "");
+        }
+        for (const e of namespace.enums) {
+            content.push(renderer.enum(e), "");
+        }
+        for (const union of namespace.unions) {
+            content.push(renderer.union(union), "");
+        }
+        for (const scalar of namespace.scalars) {
+            content.push(renderer.scalar(scalar), "");
+        }
+        return content;
+    })));
+    return renderMarkdowDoc(content);
+}
+function renderEmitter(renderer, refDoc) {
+    var _a;
+    if (((_a = refDoc.emitter) === null || _a === void 0 ? void 0 : _a.options) === undefined) {
+        return undefined;
+    }
+    const content = [
+        "---",
+        `title: "Emitter usage"`,
+        "toc_min_heading_level: 2",
+        "toc_max_heading_level: 3",
+        "---",
+        renderer.emitterUsage(refDoc),
+    ];
+    return renderMarkdowDoc(content);
+}
+function renderLinter(renderer, refDoc) {
+    if (refDoc.linter === undefined) {
+        return undefined;
+    }
+    const content = [
+        "---",
+        `title: "Linter usage"`,
+        "toc_min_heading_level: 2",
+        "toc_max_heading_level: 3",
+        "---",
+        renderer.linterUsage(refDoc),
+    ];
+    return renderMarkdowDoc(content);
+}
+export class DocusaurusRenderer extends MarkdownRenderer {
+    constructor(refDoc) {
+        super();
+        _DocusaurusRenderer_refDoc.set(this, void 0);
+        __classPrivateFieldSet(this, _DocusaurusRenderer_refDoc, refDoc, "f");
+    }
+    headingTitle(item) {
+        // Set an explicit anchor id.
+        return `${inlinecode(item.name)} {#${item.id}}`;
+    }
+    anchorId(item) {
+        // Set an explicit anchor id.
+        return item.id;
+    }
+    install(refDoc) {
+        return section("Install", tabs([
+            {
+                id: "spec",
+                label: "In a spec",
+                content: codeblock(`npm install ${refDoc.name}`, "bash"),
+            },
+            {
+                id: "library",
+                label: "In a library",
+                content: codeblock(`npm install --save-peer ${refDoc.name}`, "bash"),
+            },
+        ]));
+    }
+    linterRuleLink(url) {
+        const homepage = __classPrivateFieldGet(this, _DocusaurusRenderer_refDoc, "f").packageJson.docusaurusWebsite;
+        if (homepage && url.includes(homepage)) {
+            const fromRoot = url.replace(homepage, "");
+            return `${fromRoot}.md`;
+        }
+        else {
+            return url;
+        }
+    }
+}
+_DocusaurusRenderer_refDoc = new WeakMap();
+//# sourceMappingURL=docusaurus.js.map

package/dist/src/ref-doc/emitters/docusaurus.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"docusaurus.js","sourceRoot":"","sources":["../../../../src/ref-doc/emitters/docusaurus.ts"],"names":[],"mappings":";;;;;;;;;;;;AAMA,OAAO,EAGL,SAAS,EACT,UAAU,EACV,gBAAgB,EAChB,OAAO,EACP,IAAI,GACL,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAEnE;;GAEG;AACH,MAAM,UAAU,0BAA0B,CAAC,MAAsB;IAC/D,MAAM,QAAQ,GAAG,IAAI,kBAAkB,CAAC,MAAM,CAAC,CAAC;IAChD,MAAM,KAAK,GAA2B;QACpC,WAAW,EAAE,eAAe,CAAC,QAAQ,EAAE,MAAM,CAAC;KAC/C,CAAC;IAEF,MAAM,aAAa,GAAG,mBAAmB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAC5D,IAAI,aAAa,EAAE,CAAC;QAClB,KAAK,CAAC,eAAe,CAAC,GAAG,aAAa,CAAC;IACzC,CAAC;IAED,MAAM,aAAa,GAAG,oBAAoB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAC7D,IAAI,aAAa,EAAE,CAAC;QAClB,KAAK,CAAC,eAAe,CAAC,GAAG,aAAa,CAAC;IACzC,CAAC;IAED,MAAM,SAAS,GAAG,eAAe,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACpD,IAAI,SAAS,EAAE,CAAC;QACd,KAAK,CAAC,eAAe,CAAC,GAAG,SAAS,CAAC;IACrC,CAAC;IAED,MAAM,OAAO,GAAG,aAAa,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAChD,IAAI,OAAO,EAAE,CAAC;QACZ,KAAK,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC;IAChC,CAAC;IACD,MAAM,MAAM,GAAG,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAC9C,IAAI,MAAM,EAAE,CAAC;QACX,KAAK,CAAC,WAAW,CAAC,GAAG,MAAM,CAAC;IAC9B,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,eAAe,CAAC,QAA4B,EAAE,MAA6B;;IAClF,MAAM,OAAO,GAAgB;QAC3B,KAAK;QACL,iBAAiB;QACjB,qBAAqB;QACrB,0BAA0B;QAC1B,0BAA0B;QAC1B,KAAK;QACL,iCAAiC;QACjC,uCAAuC;QACvC,EAAE;QAEF,OAAO,CAAC,UAAU,EAAE;YAClB,MAAA,MAAM,CAAC,WAAW,mCAAI,EAAE;YACxB,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC;YACxB,CAAA,MAAA,MAAM,CAAC,OAAO,0CAAE,OAAO,EAAC,CAAC,CAAC,OAAO,CAAC,eAAe,EAAE,mCAAmC,CAAC,CAAC,CAAC,CAAC,EAAE;YAE5F,gBAAgB,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,SAAS,EAAE,EAAE;gBAChD,MAAM,OAAO,GAAG,EAAE,CAAC;gBAEnB,IAAI,SAAS,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACpC,OAAO,CAAC,IAAI,CACV,OAAO,CAAC,YAAY,EAAE,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC,CAC7E,CAAC;gBACJ,CAAC;gBAED,IAAI,SAAS,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACpC,OAAO,CAAC,IAAI,CACV,OAAO,CAAC,YAAY,EAAE,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC,CAC7E,CAAC;gBACJ,CAAC;gBAED,IAAI,SAAS,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACpC,OAAO,CAAC,IAAI,CACV,OAAO,CAAC,YAAY,EAAE,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC,CAC7E,CAAC;gBACJ,CAAC;gBAED,IAAI,SAAS,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAChC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC;gBACrF,CAAC;gBACD,OAAO,OAAO,CAAC;YACjB,CAAC,CAAC;SACH,CAAC;KACH,CAAC;IAEF,OAAO,gBAAgB,CAAC,OAAO,CAAC,CAAC;AACnC,CAAC;AAMD,MAAM,UAAU,mBAAmB,CACjC,QAA4B,EAC5B,MAA0B,EAC1B,OAAgC;;IAEhC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,CAAC;QAC5D,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,KAAK,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,mCAAI,YAAY,CAAC;IAC7C,MAAM,OAAO,GAAgB;QAC3B,KAAK;QACL,WAAW,KAAK,GAAG;QACnB,0BAA0B;QAC1B,0BAA0B;QAC1B,KAAK;KACN,CAAC;IAEF,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACjE,OAAO,gBAAgB,CAAC,OAAO,CAAC,CAAC;AACnC,CAAC;AAED,SAAS,oBAAoB,CAC3B,QAA4B,EAC5B,MAAsB;IAEtB,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,CAAC;QACvF,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,OAAO,GAAgB;QAC3B,KAAK;QACL,oCAAoC;QACpC,0BAA0B;QAC1B,0BAA0B;QAC1B,KAAK;KACN,CAAC;IAEF,OAAO,CAAC,IAAI,CACV,OAAO,CAAC,2BAA2B,EAAE;QACnC,gBAAgB,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,SAAS,EAAE,EAAE;YAChD,IAAI,SAAS,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,IAAI,SAAS,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC3E,OAAO,SAAS,CAAC;YACnB,CAAC;YAED,MAAM,OAAO,GAAgB,EAAE,CAAC;YAChC,KAAK,MAAM,KAAK,IAAI,SAAS,CAAC,UAAU,EAAE,CAAC;gBACzC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;YAC9C,CAAC;YAED,KAAK,MAAM,SAAS,IAAI,SAAS,CAAC,UAAU,EAAE,CAAC;gBAC7C,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,EAAE,CAAC,CAAC;YAClD,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC,CAAC;KACH,CAAC,CACH,CAAC;IAEF,OAAO,gBAAgB,CAAC,OAAO,CAAC,CAAC;AACnC,CAAC;AAMD,MAAM,UAAU,eAAe,CAC7B,QAA4B,EAC5B,MAAsB,EACtB,OAA+B;;IAE/B,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,CAAC;QACxD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,KAAK,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,mCAAI,YAAY,CAAC;IAC7C,MAAM,OAAO,GAAgB;QAC3B,KAAK;QACL,WAAW,KAAK,GAAG;QACnB,0BAA0B;QAC1B,0BAA0B;QAC1B,KAAK;KACN,CAAC;IAEF,OAAO,CAAC,IAAI,CACV,OAAO,CACL,YAAY,EACZ,gBAAgB,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,SAAS,EAAE,EAAE;QAChD,MAAM,UAAU,GACd,SAAS,CAAC,MAAM,CAAC,MAAM;YACvB,SAAS,CAAC,KAAK,CAAC,MAAM;YACtB,SAAS,CAAC,MAAM,CAAC,MAAM;YACvB,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC;QAC3B,IAAI,UAAU,KAAK,CAAC,EAAE,CAAC;YACrB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,MAAM,OAAO,GAAgB,EAAE,CAAC;QAChC,KAAK,MAAM,KAAK,IAAI,SAAS,CAAC,MAAM,EAAE,CAAC;YACrC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;QAC1C,CAAC;QACD,KAAK,MAAM,CAAC,IAAI,SAAS,CAAC,KAAK,EAAE,CAAC;YAChC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACrC,CAAC;QACD,KAAK,MAAM,KAAK,IAAI,SAAS,CAAC,MAAM,EAAE,CAAC;YACrC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;QAC1C,CAAC;QACD,KAAK,MAAM,MAAM,IAAI,SAAS,CAAC,OAAO,EAAE,CAAC;YACvC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC;QAC5C,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC,CAAC,CACH,CACF,CAAC;IAEF,OAAO,gBAAgB,CAAC,OAAO,CAAC,CAAC;AACnC,CAAC;AAED,SAAS,aAAa,CACpB,QAA4B,EAC5B,MAA6B;;IAE7B,IAAI,CAAA,MAAA,MAAM,CAAC,OAAO,0CAAE,OAAO,MAAK,SAAS,EAAE,CAAC;QAC1C,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,OAAO,GAAgB;QAC3B,KAAK;QACL,wBAAwB;QACxB,0BAA0B;QAC1B,0BAA0B;QAC1B,KAAK;QACL,QAAQ,CAAC,YAAY,CAAC,MAAM,CAAC;KAC9B,CAAC;IAEF,OAAO,gBAAgB,CAAC,OAAO,CAAC,CAAC;AACnC,CAAC;AACD,SAAS,YAAY,CACnB,QAA4B,EAC5B,MAA6B;IAE7B,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAChC,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,OAAO,GAAgB;QAC3B,KAAK;QACL,uBAAuB;QACvB,0BAA0B;QAC1B,0BAA0B;QAC1B,KAAK;QACL,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC;KAC7B,CAAC;IAEF,OAAO,gBAAgB,CAAC,OAAO,CAAC,CAAC;AACnC,CAAC;AAED,MAAM,OAAO,kBAAmB,SAAQ,gBAAgB;IAEtD,YAAY,MAA6B;QACvC,KAAK,EAAE,CAAC;QAFV,6CAA+B;QAG7B,uBAAA,IAAI,8BAAW,MAAM,MAAA,CAAC;IACxB,CAAC;IACD,YAAY,CAAC,IAAqB;QAChC,6BAA6B;QAC7B,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,EAAE,GAAG,CAAC;IAClD,CAAC;IACD,QAAQ,CAAC,IAAqB;QAC5B,6BAA6B;QAC7B,OAAO,IAAI,CAAC,EAAE,CAAC;IACjB,CAAC;IAED,OAAO,CAAC,MAA6B;QACnC,OAAO,OAAO,CACZ,SAAS,EACT,IAAI,CAAC;YACH;gBACE,EAAE,EAAE,MAAM;gBACV,KAAK,EAAE,WAAW;gBAClB,OAAO,EAAE,SAAS,CAAC,eAAe,MAAM,CAAC,IAAI,EAAE,EAAE,MAAM,CAAC;aACzD;YACD;gBACE,EAAE,EAAE,SAAS;gBACb,KAAK,EAAE,cAAc;gBACrB,OAAO,EAAE,SAAS,CAAC,2BAA2B,MAAM,CAAC,IAAI,EAAE,EAAE,MAAM,CAAC;aACrE;SACF,CAAC,CACH,CAAC;IACJ,CAAC;IAED,cAAc,CAAC,GAAW;QACxB,MAAM,QAAQ,GAAI,uBAAA,IAAI,kCAAQ,CAAC,WAAmB,CAAC,iBAAiB,CAAC;QACrE,IAAI,QAAQ,IAAI,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YACvC,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YAC3C,OAAO,GAAG,QAAQ,KAAK,CAAC;QAC1B,CAAC;aAAM,CAAC;YACN,OAAO,GAAG,CAAC;QACb,CAAC;IACH,CAAC;CACF"}

package/dist/src/ref-doc/emitters/markdown.d.ts

@@ -0,0 +1,32 @@
+import { DecoratorRefDoc, EmitterOptionRefDoc, EnumRefDoc, ExampleRefDoc, InterfaceRefDoc, LinterRuleRefDoc, ModelRefDoc, NamedTypeRefDoc, NamespaceRefDoc, OperationRefDoc, ReferencableElement, ScalarRefDoc, TemplateParameterRefDoc, TypeSpecRefDoc, TypeSpecRefDocBase, UnionRefDoc } from "../types.js";
+import { MarkdownDoc } from "../utils/markdown.js";
+export declare function renderReadme(refDoc: TypeSpecRefDoc, projectRoot: string): Promise<string>;
+export declare function groupByNamespace(namespaces: NamespaceRefDoc[], callback: (namespace: NamespaceRefDoc) => MarkdownDoc | undefined): MarkdownDoc;
+/**
+ * Github flavored markdown renderer.
+ */
+export declare class MarkdownRenderer {
+    headingTitle(item: NamedTypeRefDoc): string;
+    anchorId(item: ReferencableElement): string;
+    operation(op: OperationRefDoc): import("../utils/markdown.js").MarkdownSection;
+    interface(iface: InterfaceRefDoc): import("../utils/markdown.js").MarkdownSection;
+    model(model: ModelRefDoc): import("../utils/markdown.js").MarkdownSection;
+    enum(e: EnumRefDoc): MarkdownDoc;
+    union(union: UnionRefDoc): MarkdownDoc;
+    scalar(scalar: ScalarRefDoc): MarkdownDoc;
+    templateParameters(templateParameters: TemplateParameterRefDoc[]): MarkdownDoc;
+    decorator(dec: DecoratorRefDoc): import("../utils/markdown.js").MarkdownSection;
+    examples(examples: ExampleRefDoc[]): "" | import("../utils/markdown.js").MarkdownSection;
+    /** Render all decorators */
+    decoratorsSection(refDoc: TypeSpecRefDocBase, options?: {
+        includeToc?: boolean;
+    }): MarkdownDoc;
+    toc(items: ReferencableElement[], filename?: string): string[];
+    install(refDoc: TypeSpecRefDoc): import("../utils/markdown.js").MarkdownSection;
+    emitterUsage(refDoc: TypeSpecRefDoc): import("../utils/markdown.js").MarkdownSection | never[];
+    emitterOptions(options: EmitterOptionRefDoc[]): import("../utils/markdown.js").MarkdownSection;
+    linterUsage(refDoc: TypeSpecRefDoc): import("../utils/markdown.js").MarkdownSection | never[];
+    linterRuleToc(rules: LinterRuleRefDoc[]): string;
+    linterRuleLink(url: string): string;
+}
+//# sourceMappingURL=markdown.d.ts.map

package/dist/src/ref-doc/emitters/markdown.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown.d.ts","sourceRoot":"","sources":["../../../../src/ref-doc/emitters/markdown.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,UAAU,EACV,aAAa,EACb,eAAe,EACf,gBAAgB,EAChB,WAAW,EACX,eAAe,EACf,eAAe,EACf,eAAe,EACf,mBAAmB,EACnB,YAAY,EACZ,uBAAuB,EACvB,cAAc,EACd,kBAAkB,EAClB,WAAW,EACZ,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,WAAW,EAOZ,MAAM,sBAAsB,CAAC;AAe9B,wBAAsB,YAAY,CAAC,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,mBA2B7E;AAED,wBAAgB,gBAAgB,CAC9B,UAAU,EAAE,eAAe,EAAE,EAC7B,QAAQ,EAAE,CAAC,SAAS,EAAE,eAAe,KAAK,WAAW,GAAG,SAAS,GAChE,WAAW,CASb;AAED;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,YAAY,CAAC,IAAI,EAAE,eAAe,GAAG,MAAM;IAI3C,QAAQ,CAAC,IAAI,EAAE,mBAAmB,GAAG,MAAM;IAK3C,SAAS,CAAC,EAAE,EAAE,eAAe;IAY7B,SAAS,CAAC,KAAK,EAAE,eAAe;IAkBhC,KAAK,CAAC,KAAK,EAAE,WAAW;IAYxB,IAAI,CAAC,CAAC,EAAE,UAAU,GAAG,WAAW;IAYhC,KAAK,CAAC,KAAK,EAAE,WAAW,GAAG,WAAW;IAYtC,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,WAAW;IAYzC,kBAAkB,CAAC,kBAAkB,EAAE,uBAAuB,EAAE,GAAG,WAAW;IAS9E,SAAS,CAAC,GAAG,EAAE,eAAe;IAsB9B,QAAQ,CAAC,QAAQ,EAAE,aAAa,EAAE;IAkBlC,4BAA4B;IAC5B,iBAAiB,CACf,MAAM,EAAE,kBAAkB,EAC1B,OAAO,GAAE;QAAE,UAAU,CAAC,EAAE,OAAO,CAAA;KAAO,GACrC,WAAW;IAYd,GAAG,CAAC,KAAK,EAAE,mBAAmB,EAAE,EAAE,QAAQ,CAAC,EAAE,MAAM;IAMnD,OAAO,CAAC,MAAM,EAAE,cAAc;IAI9B,YAAY,CAAC,MAAM,EAAE,cAAc;IAgBnC,cAAc,CAAC,OAAO,EAAE,mBAAmB,EAAE;IAY7C,WAAW,CAAC,MAAM,EAAE,cAAc;IAkBlC,aAAa,CAAC,KAAK,EAAE,gBAAgB,EAAE;IAWvC,cAAc,CAAC,GAAG,EAAE,MAAM;CAG3B"}