@typespec/tspd 0.47.0-dev.0

package/dist/src/ref-doc/types.d.ts

@@ -0,0 +1,109 @@
+import { Decorator, Enum, FunctionParameter, Interface, LinterRuleDefinition, LinterRuleSet, Model, NodePackage, Operation, Scalar, Union } from "@typespec/compiler";
+export type TypeSpecRefDoc = TypeSpecLibraryRefDoc;
+export type TypeSpecLibraryRefDoc = TypeSpecRefDocBase & {
+    /**
+     * Library name
+     */
+    name: string;
+    /**
+     * Library package.json
+     */
+    packageJson: NodePackage;
+    /**
+     * Library description
+     */
+    description?: string;
+    emitter?: EmitterRefDoc;
+    /** Documentation about the linter rules and ruleset provided in this library. */
+    linter?: LinterRefDoc;
+};
+export type TypeSpecRefDocBase = {
+    namespaces: NamespaceRefDoc[];
+};
+export type EmitterRefDoc = {
+    options: EmitterOptionRefDoc[];
+};
+export type LinterRefDoc = {
+    /** List of rulesets provided. */
+    ruleSets?: LinterRuleSetRefDoc[];
+    rules: LinterRuleRefDoc[];
+};
+export type LinterRuleSetRefDoc = ReferencableElement & {
+    ruleSet: LinterRuleSet;
+};
+export type LinterRuleRefDoc = ReferencableElement & {
+    rule: LinterRuleDefinition<any, any>;
+};
+export type EmitterOptionRefDoc = {
+    name: string;
+    type: string;
+    doc: string;
+};
+export type NamespaceRefDoc = {
+    id: string;
+    decorators: DecoratorRefDoc[];
+    operations: OperationRefDoc[];
+    interfaces: InterfaceRefDoc[];
+    models: ModelRefDoc[];
+    enums: EnumRefDoc[];
+    unions: UnionRefDoc[];
+    scalars: ScalarRefDoc[];
+};
+export type ReferencableElement = {
+    /**
+     * Fully qualified id
+     */
+    id: string;
+    name: string;
+};
+export type NamedTypeRefDoc = ReferencableElement & {
+    signature: string;
+    doc: string;
+    examples: ExampleRefDoc[];
+};
+export type DecoratorRefDoc = NamedTypeRefDoc & {
+    type: Decorator;
+    target: FunctionParameterRefDoc;
+    parameters: FunctionParameterRefDoc[];
+    otherTags: string[];
+};
+export type FunctionParameterRefDoc = {
+    type: FunctionParameter;
+    name: string;
+    doc: string;
+    optional: boolean;
+    rest: boolean;
+};
+export type ExampleRefDoc = {
+    title?: string;
+    content: string;
+};
+export type OperationRefDoc = NamedTypeRefDoc & {
+    type: Operation;
+    templateParameters?: TemplateParameterRefDoc[];
+};
+export type InterfaceRefDoc = NamedTypeRefDoc & {
+    type: Interface;
+    templateParameters?: TemplateParameterRefDoc[];
+    interfaceOperations: OperationRefDoc[];
+};
+export type TemplateParameterRefDoc = {
+    name: string;
+    doc: string;
+};
+export type ModelRefDoc = NamedTypeRefDoc & {
+    type: Model;
+    templateParameters?: TemplateParameterRefDoc[];
+};
+export type EnumRefDoc = NamedTypeRefDoc & {
+    type: Enum;
+};
+export type UnionRefDoc = NamedTypeRefDoc & {
+    type: Union;
+    templateParameters?: TemplateParameterRefDoc[];
+};
+export type ScalarRefDoc = NamedTypeRefDoc & {
+    type: Scalar;
+    templateParameters?: TemplateParameterRefDoc[];
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/src/ref-doc/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/ref-doc/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,IAAI,EACJ,iBAAiB,EACjB,SAAS,EACT,oBAAoB,EACpB,aAAa,EACb,KAAK,EACL,WAAW,EACX,SAAS,EACT,MAAM,EACN,KAAK,EACN,MAAM,oBAAoB,CAAC;AAE5B,MAAM,MAAM,cAAc,GAAG,qBAAqB,CAAC;AAEnD,MAAM,MAAM,qBAAqB,GAAG,kBAAkB,GAAG;IACvD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,WAAW,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,OAAO,CAAC,EAAE,aAAa,CAAC;IAExB,iFAAiF;IACjF,MAAM,CAAC,EAAE,YAAY,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,UAAU,EAAE,eAAe,EAAE,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,EAAE,mBAAmB,EAAE,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,iCAAiC;IACjC,QAAQ,CAAC,EAAE,mBAAmB,EAAE,CAAC;IACjC,KAAK,EAAE,gBAAgB,EAAE,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,mBAAmB,GAAG;IACtD,OAAO,EAAE,aAAa,CAAC;CACxB,CAAC;AACF,MAAM,MAAM,gBAAgB,GAAG,mBAAmB,GAAG;IACnD,IAAI,EAAE,oBAAoB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;CACtC,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,eAAe,EAAE,CAAC;IAC9B,UAAU,EAAE,eAAe,EAAE,CAAC;IAC9B,UAAU,EAAE,eAAe,EAAE,CAAC;IAC9B,MAAM,EAAE,WAAW,EAAE,CAAC;IACtB,KAAK,EAAE,UAAU,EAAE,CAAC;IACpB,MAAM,EAAE,WAAW,EAAE,CAAC;IACtB,OAAO,EAAE,YAAY,EAAE,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,mBAAmB,GAAG;IAClD,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,aAAa,EAAE,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,eAAe,GAAG;IAC9C,IAAI,EAAE,SAAS,CAAC;IAChB,MAAM,EAAE,uBAAuB,CAAC;IAChC,UAAU,EAAE,uBAAuB,EAAE,CAAC;IACtC,SAAS,EAAE,MAAM,EAAE,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,IAAI,EAAE,iBAAiB,CAAC;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,OAAO,CAAC;IAClB,IAAI,EAAE,OAAO,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,eAAe,GAAG;IAC9C,IAAI,EAAE,SAAS,CAAC;IAEhB,kBAAkB,CAAC,EAAE,uBAAuB,EAAE,CAAC;CAChD,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,eAAe,GAAG;IAC9C,IAAI,EAAE,SAAS,CAAC;IAChB,kBAAkB,CAAC,EAAE,uBAAuB,EAAE,CAAC;IAE/C,mBAAmB,EAAE,eAAe,EAAE,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,eAAe,GAAG;IAC1C,IAAI,EAAE,KAAK,CAAC;IAEZ,kBAAkB,CAAC,EAAE,uBAAuB,EAAE,CAAC;CAChD,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG,eAAe,GAAG;IACzC,IAAI,EAAE,IAAI,CAAC;CACZ,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,eAAe,GAAG;IAC1C,IAAI,EAAE,KAAK,CAAC;IAEZ,kBAAkB,CAAC,EAAE,uBAAuB,EAAE,CAAC;CAChD,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,eAAe,GAAG;IAC3C,IAAI,EAAE,MAAM,CAAC;IAEb,kBAAkB,CAAC,EAAE,uBAAuB,EAAE,CAAC;CAChD,CAAC"}

package/dist/src/ref-doc/types.js

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

package/dist/src/ref-doc/types.js.map

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

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

@@ -0,0 +1,27 @@
+export declare const headings: {
+    h1: (title: string) => string;
+    h2: (title: string) => string;
+    h3: (title: string) => string;
+    h4: (title: string) => string;
+    h5: (title: string) => string;
+    hx: (number: number, title: string) => string;
+};
+export declare function codeblock(code: string, lang?: string): string;
+export declare function inlinecode(code: string): string;
+export declare function link(text: string, url: string): string;
+export declare function table([header, ...rows]: string[][]): string;
+export type Tab = {
+    id: string;
+    label: string;
+    content: string;
+};
+export declare function tabs(tabs: Tab[]): string;
+export interface MarkdownSection {
+    kind: "section";
+    title: string;
+    body: MarkdownDoc;
+}
+export type MarkdownDoc = string | MarkdownSection | MarkdownDoc[];
+export declare function renderMarkdowDoc(doc: MarkdownDoc, heading?: number): string;
+export declare function section(title: string, body: MarkdownDoc): MarkdownSection;
+//# sourceMappingURL=markdown.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"markdown.d.ts","sourceRoot":"","sources":["../../../../src/ref-doc/utils/markdown.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,QAAQ;gBAaJ,MAAM;gBAAN,MAAM;gBAAN,MAAM;gBAAN,MAAM;gBAAN,MAAM;iBAPR,MAAM,SAAS,MAAM;CAGnC,CAAC;AAOF,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,MAAW,UAExD;AAED,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,UAEtC;AAED,wBAAgB,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,UAE7C;AAMD,wBAAgB,KAAK,CAAC,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,UAQlD;AAED,MAAM,MAAM,GAAG,GAAG;IAChB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,wBAAgB,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,UAa/B;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,WAAW,CAAC;CACnB;AACD,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,eAAe,GAAG,WAAW,EAAE,CAAC;AAEnE,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,WAAW,EAAE,OAAO,SAAI,UAiB7D;AAED,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,eAAe,CAMzE"}

package/dist/src/ref-doc/utils/markdown.js

@@ -0,0 +1,70 @@
+export const headings = {
+    h1: hx(1),
+    h2: hx(2),
+    h3: hx(3),
+    h4: hx(4),
+    h5: hx(5),
+    hx: (number, title) => {
+        return "#".repeat(number) + " " + title;
+    },
+};
+function hx(number) {
+    const prefix = "#".repeat(number) + " ";
+    return (title) => prefix + title;
+}
+export function codeblock(code, lang = "") {
+    return "```" + lang + "\n" + code + "\n" + "```";
+}
+export function inlinecode(code) {
+    return "`" + code + "`";
+}
+export function link(text, url) {
+    return `[${text}](${url})`;
+}
+function escapeMarkdownTable(text) {
+    return text.replace(/(\|)/g, "\\$1").replace(/\n/g, "<br />");
+}
+export function table([header, ...rows]) {
+    const renderRow = (row) => `| ${row.map(escapeMarkdownTable).join(" | ")} |`;
+    return [
+        renderRow(header),
+        "|" + header.map((x) => "-".repeat(x.length + 2)).join("|") + "|",
+        ...rows.map(renderRow),
+    ].join("\n");
+}
+export function tabs(tabs) {
+    const result = ["<Tabs>"];
+    for (const tab of tabs) {
+        result.push(`<TabItem value="${tab.id}" label="${tab.label}" default>`, "", tab.content, "", "</TabItem>");
+    }
+    result.push("</Tabs>", "");
+    return result.join("\n");
+}
+export function renderMarkdowDoc(doc, heading = 1) {
+    const flattened = [];
+    let currentHeading = heading;
+    function render(doc) {
+        if (typeof doc === "string") {
+            flattened.push(doc);
+        }
+        else if (Array.isArray(doc)) {
+            doc.forEach(render);
+        }
+        else {
+            flattened.push(headings.hx(currentHeading, doc.title));
+            currentHeading++;
+            render(doc.body);
+            currentHeading--;
+        }
+    }
+    render(doc);
+    return flattened.join("\n");
+}
+export function section(title, body) {
+    return {
+        kind: "section",
+        title,
+        body,
+    };
+}
+//# sourceMappingURL=markdown.js.map

package/dist/src/ref-doc/utils/markdown.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown.js","sourceRoot":"","sources":["../../../../src/ref-doc/utils/markdown.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;IACT,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;IACT,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;IACT,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;IACT,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;IACT,EAAE,EAAE,CAAC,MAAc,EAAE,KAAa,EAAE,EAAE;QACpC,OAAO,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,GAAG,GAAG,KAAK,CAAC;IAC1C,CAAC;CACF,CAAC;AAEF,SAAS,EAAE,CAAC,MAAc;IACxB,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,GAAG,CAAC;IACxC,OAAO,CAAC,KAAa,EAAE,EAAE,CAAC,MAAM,GAAG,KAAK,CAAC;AAC3C,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,IAAY,EAAE,OAAe,EAAE;IACvD,OAAO,KAAK,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,KAAK,CAAC;AACnD,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,IAAY;IACrC,OAAO,GAAG,GAAG,IAAI,GAAG,GAAG,CAAC;AAC1B,CAAC;AAED,MAAM,UAAU,IAAI,CAAC,IAAY,EAAE,GAAW;IAC5C,OAAO,IAAI,IAAI,KAAK,GAAG,GAAG,CAAC;AAC7B,CAAC;AAED,SAAS,mBAAmB,CAAC,IAAY;IACvC,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;AAChE,CAAC;AAED,MAAM,UAAU,KAAK,CAAC,CAAC,MAAM,EAAE,GAAG,IAAI,CAAa;IACjD,MAAM,SAAS,GAAG,CAAC,GAAa,EAAU,EAAE,CAAC,KAAK,GAAG,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;IAE/F,OAAO;QACL,SAAS,CAAC,MAAM,CAAC;QACjB,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG;QACjE,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC;KACvB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACf,CAAC;AAQD,MAAM,UAAU,IAAI,CAAC,IAAW;IAC9B,MAAM,MAAM,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC1B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,MAAM,CAAC,IAAI,CACT,mBAAmB,GAAG,CAAC,EAAE,YAAY,GAAG,CAAC,KAAK,YAAY,EAC1D,EAAE,EACF,GAAG,CAAC,OAAO,EACX,EAAE,EACF,YAAY,CACb,CAAC;IACJ,CAAC;IACD,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;IAC3B,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC3B,CAAC;AASD,MAAM,UAAU,gBAAgB,CAAC,GAAgB,EAAE,OAAO,GAAG,CAAC;IAC5D,MAAM,SAAS,GAAa,EAAE,CAAC;IAC/B,IAAI,cAAc,GAAG,OAAO,CAAC;IAC7B,SAAS,MAAM,CAAC,GAAgB;QAC9B,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YAC5B,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACtB,CAAC;aAAM,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YAC9B,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACtB,CAAC;aAAM,CAAC;YACN,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,cAAc,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;YACvD,cAAc,EAAE,CAAC;YACjB,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACjB,cAAc,EAAE,CAAC;QACnB,CAAC;IACH,CAAC;IACD,MAAM,CAAC,GAAG,CAAC,CAAC;IACZ,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC9B,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,KAAa,EAAE,IAAiB;IACtD,OAAO;QACL,IAAI,EAAE,SAAS;QACf,KAAK;QACL,IAAI;KACL,CAAC;AACJ,CAAC"}

package/dist/src/ref-doc/utils/type-signature.d.ts

@@ -0,0 +1,5 @@
+import { Type } from "@typespec/compiler";
+export declare function getQualifier(parent: (Type & {
+    name?: string | symbol;
+}) | undefined): string;
+//# sourceMappingURL=type-signature.d.ts.map

package/dist/src/ref-doc/utils/type-signature.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-signature.d.ts","sourceRoot":"","sources":["../../../../src/ref-doc/utils/type-signature.ts"],"names":[],"mappings":"AAAA,OAAO,EAaL,IAAI,EAGL,MAAM,oBAAoB,CAAC;AA4I5B,wBAAgB,YAAY,CAAC,MAAM,EAAE,CAAC,IAAI,GAAG;IAAE,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,CAAC,GAAG,SAAS,UAWnF"}

package/dist/src/ref-doc/utils/type-signature.js

@@ -0,0 +1,136 @@
+import { compilerAssert, getTypeName, } from "@typespec/compiler";
+/** @internal */
+export function getTypeSignature(type) {
+    if (type.kind === "Value") {
+        return `valueof ${getTypeSignature(type.target)}`;
+    }
+    if (isReflectionType(type)) {
+        return type.name;
+    }
+    switch (type.kind) {
+        case "Scalar":
+        case "Enum":
+        case "Union":
+        case "Model":
+        case "Namespace":
+            return `${type.kind.toLowerCase()} ${getTypeName(type)}`;
+        case "Interface":
+            return getInterfaceSignature(type);
+        case "Decorator":
+            return getDecoratorSignature(type);
+        case "Function":
+            return getFunctionSignature(type);
+        case "Operation":
+            return getOperationSignature(type);
+        case "String":
+            return `(string) ${`"${type.value}"`}`;
+        case "Boolean":
+            return `(boolean) ${type.value ? "true" : "false"}`;
+        case "Number":
+            return `(number) ${type.value.toString()}`;
+        case "Intrinsic":
+            return `(intrinsic) ${type.name}`;
+        case "FunctionParameter":
+            return getFunctionParameterSignature(type);
+        case "StringTemplate":
+            return `(string template)\n${getStringTemplateSignature(type)}`;
+        case "StringTemplateSpan":
+            return `(string template span)\n${getTypeName(type.type)}`;
+        case "ModelProperty":
+            return `(model property) ${`${type.name}: ${getTypeName(type.type)}`}`;
+        case "EnumMember":
+            return `(enum member) ${getEnumMemberSignature(type)}`;
+        case "TemplateParameter":
+            return type.node.id.sv;
+        case "UnionVariant":
+            return `(union variant) ${getUnionVariantSignature(type)}`;
+        case "Tuple":
+            return `(tuple) [${type.values.map(getTypeSignature).join(", ")}]`;
+        case "Projection":
+            return "(projection)";
+        case "Object":
+            return "(object)";
+        default:
+            const _assertNever = type;
+            compilerAssert(false, "Unexpected type kind");
+    }
+}
+function isReflectionType(type) {
+    var _a, _b, _c;
+    return (type.kind === "Model" &&
+        ((_a = type.namespace) === null || _a === void 0 ? void 0 : _a.name) === "Reflection" &&
+        ((_c = (_b = type.namespace) === null || _b === void 0 ? void 0 : _b.namespace) === null || _c === void 0 ? void 0 : _c.name) === "TypeSpec");
+}
+function getDecoratorSignature(type) {
+    const ns = getQualifier(type.namespace);
+    const name = type.name.slice(1);
+    const parameters = [...type.parameters].map((x) => getFunctionParameterSignature(x));
+    let signature = `@${ns}${name}`;
+    if (parameters.length > 0) {
+        signature += `(${parameters.join(", ")})`;
+    }
+    return signature;
+}
+function getFunctionSignature(type) {
+    const ns = getQualifier(type.namespace);
+    const parameters = type.parameters.map((x) => getFunctionParameterSignature(x));
+    return `fn ${ns}${type.name}(${parameters.join(", ")}): ${getTypeName(type.returnType)}`;
+}
+function getInterfaceSignature(type) {
+    const ns = getQualifier(type.namespace);
+    const templateParams = type.node.templateParameters
+        ? getTemplateParameters(type.node.templateParameters)
+        : "";
+    return `interface ${ns}${type.name}${templateParams}`;
+}
+function getTemplateParameters(templateParameters) {
+    const params = templateParameters.map((x) => `${x.id.sv}`);
+    return `<${params.join(", ")}>`;
+}
+function getOperationSignature(type) {
+    var _a;
+    const qualifier = getQualifier((_a = type.interface) !== null && _a !== void 0 ? _a : type.namespace);
+    const parameters = [...type.parameters.properties.values()].map(getModelPropertySignature);
+    return `op ${qualifier}${type.name}(${parameters.join(", ")}): ${getTypeName(type.returnType)}`;
+}
+function getFunctionParameterSignature(parameter) {
+    const rest = parameter.rest ? "..." : "";
+    const optional = parameter.optional ? "?" : "";
+    return `${rest}${parameter.name}${optional}: ${getTypeName(parameter.type)}`;
+}
+function getStringTemplateSignature(stringTemplate) {
+    return ("`" +
+        [
+            stringTemplate.spans.map((span) => {
+                return span.isInterpolated ? "${" + getTypeName(span.type) + "}" : span.type.value;
+            }),
+        ].join("") +
+        "`");
+}
+function getModelPropertySignature(property) {
+    const ns = getQualifier(property.model);
+    return `${ns}${property.name}: ${getTypeName(property.type)}`;
+}
+function getUnionVariantSignature(variant) {
+    if (typeof variant.name !== "string") {
+        return getTypeName(variant.type);
+    }
+    const ns = getQualifier(variant.union);
+    return `${ns}${variant.name}: ${getTypeName(variant.type)}`;
+}
+function getEnumMemberSignature(member) {
+    const ns = getQualifier(member.enum);
+    const value = typeof member.value === "string" ? `"${member.value}"` : member.value;
+    return value === undefined ? `${ns}${member.name}` : `${ns}${member.name}: ${value}`;
+}
+export function getQualifier(parent) {
+    if (!(parent === null || parent === void 0 ? void 0 : parent.name) || typeof parent.name !== "string") {
+        return "";
+    }
+    const parentName = getTypeName(parent);
+    if (!parentName || parentName === "TypeSpec") {
+        return "";
+    }
+    return parentName + ".";
+}
+//# sourceMappingURL=type-signature.js.map

package/dist/src/ref-doc/utils/type-signature.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-signature.js","sourceRoot":"","sources":["../../../../src/ref-doc/utils/type-signature.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EAKd,WAAW,GAUZ,MAAM,oBAAoB,CAAC;AAE5B,gBAAgB;AAChB,MAAM,UAAU,gBAAgB,CAAC,IAAsB;IACrD,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QAC1B,OAAO,WAAW,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;IACpD,CAAC;IACD,IAAI,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3B,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IACD,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,QAAQ,CAAC;QACd,KAAK,MAAM,CAAC;QACZ,KAAK,OAAO,CAAC;QACb,KAAK,OAAO,CAAC;QACb,KAAK,WAAW;YACd,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3D,KAAK,WAAW;YACd,OAAO,qBAAqB,CAAC,IAAI,CAAC,CAAC;QACrC,KAAK,WAAW;YACd,OAAO,qBAAqB,CAAC,IAAI,CAAC,CAAC;QACrC,KAAK,UAAU;YACb,OAAO,oBAAoB,CAAC,IAAI,CAAC,CAAC;QACpC,KAAK,WAAW;YACd,OAAO,qBAAqB,CAAC,IAAI,CAAC,CAAC;QACrC,KAAK,QAAQ;YACX,OAAO,YAAY,IAAI,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;QACzC,KAAK,SAAS;YACZ,OAAO,aAAa,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;QACtD,KAAK,QAAQ;YACX,OAAO,YAAY,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC;QAC7C,KAAK,WAAW;YACd,OAAO,eAAe,IAAI,CAAC,IAAI,EAAE,CAAC;QACpC,KAAK,mBAAmB;YACtB,OAAO,6BAA6B,CAAC,IAAI,CAAC,CAAC;QAC7C,KAAK,gBAAgB;YACnB,OAAO,sBAAsB,0BAA0B,CAAC,IAAI,CAAC,EAAE,CAAC;QAClE,KAAK,oBAAoB;YACvB,OAAO,2BAA2B,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAC7D,KAAK,eAAe;YAClB,OAAO,oBAAoB,GAAG,IAAI,CAAC,IAAI,KAAK,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;QACzE,KAAK,YAAY;YACf,OAAO,iBAAiB,sBAAsB,CAAC,IAAI,CAAC,EAAE,CAAC;QACzD,KAAK,mBAAmB;YACtB,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;QACzB,KAAK,cAAc;YACjB,OAAO,mBAAmB,wBAAwB,CAAC,IAAI,CAAC,EAAE,CAAC;QAC7D,KAAK,OAAO;YACV,OAAO,YAAY,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;QACrE,KAAK,YAAY;YACf,OAAO,cAAc,CAAC;QACxB,KAAK,QAAQ;YACX,OAAO,UAAU,CAAC;QACpB;YACE,MAAM,YAAY,GAAU,IAAI,CAAC;YACjC,cAAc,CAAC,KAAK,EAAE,sBAAsB,CAAC,CAAC;IAClD,CAAC;AACH,CAAC;AAED,SAAS,gBAAgB,CAAC,IAAU;;IAClC,OAAO,CACL,IAAI,CAAC,IAAI,KAAK,OAAO;QACrB,CAAA,MAAA,IAAI,CAAC,SAAS,0CAAE,IAAI,MAAK,YAAY;QACrC,CAAA,MAAA,MAAA,IAAI,CAAC,SAAS,0CAAE,SAAS,0CAAE,IAAI,MAAK,UAAU,CAC/C,CAAC;AACJ,CAAC;AAED,SAAS,qBAAqB,CAAC,IAAe;IAC5C,MAAM,EAAE,GAAG,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACxC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAChC,MAAM,UAAU,GAAG,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,6BAA6B,CAAC,CAAC,CAAC,CAAC,CAAC;IACrF,IAAI,SAAS,GAAG,IAAI,EAAE,GAAG,IAAI,EAAE,CAAC;IAChC,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1B,SAAS,IAAI,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;IAC5C,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,oBAAoB,CAAC,IAAkB;IAC9C,MAAM,EAAE,GAAG,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACxC,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,6BAA6B,CAAC,CAAC,CAAC,CAAC,CAAC;IAChF,OAAO,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;AAC3F,CAAC;AAED,SAAS,qBAAqB,CAAC,IAAe;IAC5C,MAAM,EAAE,GAAG,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAExC,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,kBAAkB;QACjD,CAAC,CAAC,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC;QACrD,CAAC,CAAC,EAAE,CAAC;IACP,OAAO,aAAa,EAAE,GAAG,IAAI,CAAC,IAAI,GAAG,cAAc,EAAE,CAAC;AACxD,CAAC;AAED,SAAS,qBAAqB,CAAC,kBAA+D;IAC5F,MAAM,MAAM,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IAC3D,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;AAClC,CAAC;AACD,SAAS,qBAAqB,CAAC,IAAe;;IAC5C,MAAM,SAAS,GAAG,YAAY,CAAC,MAAA,IAAI,CAAC,SAAS,mCAAI,IAAI,CAAC,SAAS,CAAC,CAAC;IACjE,MAAM,UAAU,GAAG,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;IAC3F,OAAO,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;AAClG,CAAC;AAED,SAAS,6BAA6B,CAAC,SAA4B;IACjE,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;IACzC,MAAM,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IAC/C,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC,IAAI,GAAG,QAAQ,KAAK,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;AAC/E,CAAC;AAED,SAAS,0BAA0B,CAAC,cAA8B;IAChE,OAAO,CACL,GAAG;QACH;YACE,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;gBAChC,OAAO,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;YACrF,CAAC,CAAC;SACH,CAAC,IAAI,CAAC,EAAE,CAAC;QACV,GAAG,CACJ,CAAC;AACJ,CAAC;AAED,SAAS,yBAAyB,CAAC,QAAuB;IACxD,MAAM,EAAE,GAAG,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACxC,OAAO,GAAG,EAAE,GAAG,QAAQ,CAAC,IAAI,KAAK,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;AAChE,CAAC;AAED,SAAS,wBAAwB,CAAC,OAAqB;IACrD,IAAI,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QACrC,OAAO,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IACD,MAAM,EAAE,GAAG,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACvC,OAAO,GAAG,EAAE,GAAG,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;AAC9D,CAAC;AAED,SAAS,sBAAsB,CAAC,MAAkB;IAChD,MAAM,EAAE,GAAG,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACrC,MAAM,KAAK,GAAG,OAAO,MAAM,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;IACpF,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;AACvF,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,MAAuD;IAClF,IAAI,CAAC,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,CAAA,IAAI,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QACrD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,UAAU,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;IACvC,IAAI,CAAC,UAAU,IAAI,UAAU,KAAK,UAAU,EAAE,CAAC;QAC7C,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,OAAO,UAAU,GAAG,GAAG,CAAC;AAC1B,CAAC"}

package/package.json

@@ -0,0 +1,81 @@
+{
+  "name": "@typespec/tspd",
+  "version": "0.47.0-dev.0",
+  "author": "Microsoft Corporation",
+  "description": "TypeSpec library for generating TypeSpec docs",
+  "homepage": "https://microsoft.github.io/typespec",
+  "readme": "https://github.com/microsoft/typespec/blob/main/README.md",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/microsoft/typespec.git"
+  },
+  "bugs": {
+    "url": "https://github.com/microsoft/typespec/issues"
+  },
+  "keywords": [
+    "typespec"
+  ],
+  "type": "module",
+  "bin": {
+    "tspd": "./cmd/tspd.js"
+  },
+  "main": "./dist/src/index.js",
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "default": "./dist/src/index.js"
+    },
+    "./ref-doc": {
+      "types": "./dist/src/ref-doc/index.d.ts",
+      "default": "./dist/src/ref-doc/index.js"
+    },
+    "./ref-doc/emitters/docusaurus": {
+      "types": "./dist/src/ref-doc/emitters/docusaurus.d.ts",
+      "default": "./dist/src/ref-doc/emitters/docusaurus.js"
+    }
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "files": [
+    "lib/*.tsp",
+    "dist/**",
+    "!dist/test/**"
+  ],
+  "dependencies": {
+    "@typespec/compiler": "~0.52.0 || >=0.53.0-dev <0.53.0",
+    "yaml": "~2.3.4",
+    "prettier": "~3.1.1",
+    "picocolors": "~1.0.0",
+    "yargs": "~17.7.2"
+  },
+  "devDependencies": {
+    "@typespec/compiler": "~0.52.0 || >=0.53.0-dev <0.53.0",
+    "@typespec/eslint-config-typespec": "~0.52.0 || >=0.53.0-dev <0.53.0",
+    "@typespec/prettier-plugin-typespec": "~0.52.0 || >=0.53.0-dev <0.53.0",
+    "@types/node": "~18.11.9",
+    "@types/yargs": "~17.0.32",
+    "c8": "~8.0.1",
+    "eslint": "^8.55.0",
+    "vitest": "^1.2.0",
+    "@vitest/coverage-v8": "^1.1.0",
+    "@vitest/ui": "~1.1.3",
+    "source-map-support": "~0.5.21",
+    "rimraf": "~5.0.1",
+    "typedoc-plugin-markdown": "~4.0.0-next.22",
+    "typedoc": "0.25.4",
+    "typescript": "~5.3.3"
+  },
+  "peerDependencies": {},
+  "scripts": {
+    "clean": "rimraf ./dist ./temp",
+    "build": "tsc -p .",
+    "watch": "tsc -p . --watch",
+    "test": "vitest run",
+    "test:ui": "vitest --ui",
+    "test-official": "vitest run --coverage --reporter=junit --reporter=default --no-file-parallelism",
+    "lint": "eslint . --ext .ts --max-warnings=0",
+    "lint:fix": "eslint . --fix --ext .ts"
+  }
+}