@typespec/tspd 0.70.0-dev.1 → 0.70.0-dev.3

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

@@ -1,5 +1,4 @@
 export * from "./api-docs.js";
 export * from "./experimental.js";
 export * from "./extractor.js";
-export * from "./lib.js";
-//# sourceMappingURL=index.js.map
+export * from "./lib.js";

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

@@ -1,31 +1,34 @@
 import { createTypeSpecLibrary, paramMessage } from "@typespec/compiler";
 export const libDef = {
-    name: "@typespec/tspd",
-    diagnostics: {
-        "exports-missing": {
-            severity: "error",
-            messages: {
-                default: `exports field is missing in package.json`,
-                missingCondition: `exports field is missing one export with the typespec condition`,
-            },
-        },
-        "documentation-missing": {
-            severity: "warning",
-            messages: {
-                decorator: paramMessage `Missing documentation for decorator '${"name"}'.`,
-                decoratorParam: paramMessage `Missing documentation for decorator parameter '${"name"}.${"param"}'.`,
-                templateParam: paramMessage `Missing documentation for template parameter '${"name"}.${"param"}'.`,
-                model: paramMessage `Missing documentation for model '${"name"}'.`,
-                union: paramMessage `Missing documentation for union '${"name"}'.`,
-                enum: paramMessage `Missing documentation for enum '${"name"}'.`,
-                interface: paramMessage `Missing documentation for interface '${"name"}'.`,
-                interfaceOperation: paramMessage `Missing documentation for interface operation '${"name"}'.`,
-                operation: paramMessage `Missing documentation for operation '${"name"}'.`,
-                scalar: paramMessage `Missing documentation for scalar '${"name"}'.`,
-            },
-        },
+  name: "@typespec/tspd",
+  diagnostics: {
+    "exports-missing": {
+      severity: "error",
+      messages: {
+        default: `exports field is missing in package.json`,
+        missingCondition: `exports field is missing one export with the typespec condition`
+      }
     },
+    "documentation-missing": {
+      severity: "warning",
+      messages: {
+        decorator: paramMessage`Missing documentation for decorator '${"name"}'.`,
+        decoratorParam: paramMessage`Missing documentation for decorator parameter '${"name"}.${"param"}'.`,
+        templateParam: paramMessage`Missing documentation for template parameter '${"name"}.${"param"}'.`,
+        model: paramMessage`Missing documentation for model '${"name"}'.`,
+        union: paramMessage`Missing documentation for union '${"name"}'.`,
+        enum: paramMessage`Missing documentation for enum '${"name"}'.`,
+        interface: paramMessage`Missing documentation for interface '${"name"}'.`,
+        interfaceOperation: paramMessage`Missing documentation for interface operation '${"name"}'.`,
+        operation: paramMessage`Missing documentation for operation '${"name"}'.`,
+        scalar: paramMessage`Missing documentation for scalar '${"name"}'.`
+      }
+    }
+  }
 };
 export const $lib = createTypeSpecLibrary(libDef);
-export const { reportDiagnostic, createStateSymbol, createDiagnostic } = $lib;
-//# sourceMappingURL=lib.js.map
+export const {
+  reportDiagnostic,
+  createStateSymbol,
+  createDiagnostic
+} = $lib;

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

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

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

@@ -1,62 +1,55 @@
 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;
-    },
+  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;
+  const prefix = "#".repeat(number) + " ";
+  return title => prefix + title;
 }
 export function codeblock(code, lang = "") {
-    return "```" + lang + "\n" + code + "\n" + "```";
+  return "```" + lang + "\n" + code + "\n" + "```";
 }
 export function inlinecode(code) {
-    return "`" + code + "`";
+  return "`" + code + "`";
 }
 export function link(text, url) {
-    return `[${text}](${url})`;
+  return `[${text}](${url})`;
 }
 function escapeMarkdownTable(text) {
-    return text.replace(/([^\\])(\|)/g, "$1\\$2").replace(/\n/g, "<br />");
+  return text.replace(/([^\\])(\|)/g, "$1\\$2").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");
+  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 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--;
-        }
+  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");
+  }
+  render(doc);
+  return flattened.join("\n");
 }
 export function section(title, body) {
-    return {
-        kind: "section",
-        title,
-        body,
-    };
-}
-//# sourceMappingURL=markdown.js.map
+  return {
+    kind: "section",
+    title,
+    body
+  };
+}

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

@@ -1,122 +1,113 @@
-import { compilerAssert, getEntityName, getTypeName, } from "@typespec/compiler";
+import { compilerAssert, getEntityName, getTypeName } from "@typespec/compiler";
 /** @internal */
 export function getTypeSignature(type) {
-    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 "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 "ScalarConstructor":
-            return `(scalar constructor) ${getTypeName(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(", ")}]`;
-        default:
-            const _assertNever = type;
-            compilerAssert(false, "Unexpected type kind");
-    }
+  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 "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 "ScalarConstructor":
+      return `(scalar constructor) ${getTypeName(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(", ")}]`;
+    default:
+      const _assertNever = type;
+      compilerAssert(false, "Unexpected type kind");
+  }
 }
 function isReflectionType(type) {
-    return (type.kind === "Model" &&
-        type.namespace?.name === "Reflection" &&
-        type.namespace?.namespace?.name === "TypeSpec");
+  return type.kind === "Model" && type.namespace?.name === "Reflection" && type.namespace?.namespace?.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;
+  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 getInterfaceSignature(type) {
-    const ns = getQualifier(type.namespace);
-    const templateParams = type.node?.templateParameters
-        ? getTemplateParameters(type.node.templateParameters)
-        : "";
-    return `interface ${ns}${type.name}${templateParams}`;
+  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(", ")}>`;
+  const params = templateParameters.map(x => `${x.id.sv}`);
+  return `<${params.join(", ")}>`;
 }
 function getOperationSignature(type) {
-    const qualifier = getQualifier(type.interface ?? type.namespace);
-    const parameters = [...type.parameters.properties.values()].map(getModelPropertySignature);
-    return `op ${qualifier}${type.name}(${parameters.join(", ")}): ${getTypeName(type.returnType)}`;
+  const qualifier = getQualifier(type.interface ?? 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}: ${getEntityName(parameter.type)}`;
+  const rest = parameter.rest ? "..." : "";
+  const optional = parameter.optional ? "?" : "";
+  return `${rest}${parameter.name}${optional}: ${getEntityName(parameter.type)}`;
 }
 function getStringTemplateSignature(stringTemplate) {
-    return ("`" +
-        [
-            stringTemplate.spans.map((span) => {
-                return span.isInterpolated ? "${" + getTypeName(span.type) + "}" : span.type.value;
-            }),
-        ].join("") +
-        "`");
+  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)}`;
+  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)}`;
+  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}`;
+  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?.name || typeof parent.name !== "string") {
-        return "";
-    }
-    const parentName = getTypeName(parent);
-    if (!parentName || parentName === "TypeSpec") {
-        return "";
-    }
-    return parentName + ".";
-}
-//# sourceMappingURL=type-signature.js.map
+  if (!parent?.name || typeof parent.name !== "string") {
+    return "";
+  }
+  const parentName = getTypeName(parent);
+  if (!parentName || parentName === "TypeSpec") {
+    return "";
+  }
+  return parentName + ".";
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typespec/tspd",
-  "version": "0.70.0-dev.1",
+  "version": "0.70.0-dev.3",
   "author": "Microsoft Corporation",
   "description": "TypeSpec library for generating TypeSpec docs",
   "homepage": "https://typespec.io",
@@ -44,6 +44,8 @@
     "!dist/test/**"
   ],
   "dependencies": {
+    "@alloy-js/core": "^0.15.0",
+    "@alloy-js/typescript": "^0.15.0",
     "@typespec/compiler": "^1.0.0-rc.1",
     "picocolors": "~1.1.1",
     "prettier": "~3.5.3",
@@ -53,23 +55,25 @@
     "typedoc-plugin-markdown": "^4.5.2"
   },
   "devDependencies": {
+    "@alloy-js/cli": "^0.15.0",
+    "@alloy-js/rollup-plugin": "^0.1.0",
     "@types/node": "~22.13.11",
     "@types/yargs": "~17.0.33",
     "@typespec/compiler": "^1.0.0-rc.1",
     "@typespec/prettier-plugin-typespec": "^1.0.0-rc.1",
-    "@vitest/coverage-v8": "^3.0.9",
-    "@vitest/ui": "^3.0.9",
+    "@vitest/coverage-v8": "^3.1.2",
+    "@vitest/ui": "^3.1.2",
     "c8": "^10.1.3",
     "rimraf": "~6.0.1",
     "source-map-support": "~0.5.21",
     "typescript": "~5.8.2",
-    "vitest": "^3.0.9"
+    "vitest": "^3.1.2"
   },
   "peerDependencies": {},
   "scripts": {
     "clean": "rimraf ./dist ./temp",
-    "build": "tsc -p .",
-    "watch": "tsc -p . --watch",
+    "build": "alloy build",
+    "watch": "alloy build --watch",
     "test": "vitest run",
     "test:watch": "vitest --watch",
     "test:ui": "vitest --ui",

package/dist/src/gen-extern-signatures/decorators-signatures.d.ts

@@ -1,5 +0,0 @@
-import { Program } from "@typespec/compiler";
-import { DecoratorSignature } from "./types.js";
-export declare function generateSignatureTests(namespaceName: string, importName: string, decoratorSignatureImport: string, decorators: DecoratorSignature[]): string;
-export declare function generateSignatures(program: Program, decorators: DecoratorSignature[], namespaceName: string): string;
-//# sourceMappingURL=decorators-signatures.d.ts.map

package/dist/src/gen-extern-signatures/decorators-signatures.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"decorators-signatures.d.ts","sourceRoot":"","sources":["../../../src/gen-extern-signatures/decorators-signatures.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,OAAO,EAMR,MAAM,oBAAoB,CAAC;AAG5B,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAGhD,wBAAgB,sBAAsB,CACpC,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAClB,wBAAwB,EAAE,MAAM,EAChC,UAAU,EAAE,kBAAkB,EAAE,GAC/B,MAAM,CAsBR;AAKD,wBAAgB,kBAAkB,CAChC,OAAO,EAAE,OAAO,EAChB,UAAU,EAAE,kBAAkB,EAAE,EAChC,aAAa,EAAE,MAAM,GACpB,MAAM,CAmQR"}