@typespec/emitter-framework 0.9.0-dev.8 → 0.10.0-dev.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typespec/emitter-framework",
-  "version": "0.9.0-dev.8",
+  "version": "0.10.0-dev.0",
   "type": "module",
   "main": "dist/index.js",
   "repository": {
@@ -23,9 +23,18 @@
   },
   "imports": {
     "#test/*": "./test/*",
-    "#core/*": "./src/core/*",
-    "#csharp/*": "./src/csharp/*",
-    "#typescript/*": "./src/typescript/*"
+    "#core/*": {
+      "development": "./src/core/*",
+      "default": "./dist/src/core/*"
+    },
+    "#csharp/*": {
+      "development": "./src/csharp/*",
+      "default": "./dist/src/csharp/*"
+    },
+    "#typescript/*": {
+      "development": "./src/typescript/*",
+      "default": "./dist/src/typescript/*"
+    }
   },
   "keywords": [],
   "author": "",
@@ -35,21 +44,20 @@
     "@alloy-js/core": "^0.18.2",
     "@alloy-js/typescript": "^0.18.0",
     "@alloy-js/csharp": "^0.18.0",
-    "@typespec/compiler": "^1.1.0",
-    "@typespec/http": "^1.1.0",
-    "@typespec/rest": "^0.71.0 || >=0.72.0-dev <0.72.0"
+    "@typespec/compiler": "^1.2.0",
+    "@typespec/http": "^1.2.0",
+    "@typespec/rest": "^0.72.0 || >=0.73.0-dev <0.73.0"
   },
   "devDependencies": {
     "@alloy-js/cli": "^0.18.0",
     "@alloy-js/rollup-plugin": "^0.1.0",
     "@alloy-js/core": "^0.18.2",
     "@alloy-js/typescript": "^0.18.0",
-    "@types/minimist": "^1.2.5",
-    "@typespec/compiler": "^1.1.0",
-    "@typespec/http": "^1.1.0",
-    "@typespec/rest": "^0.71.0 || >=0.72.0-dev <0.72.0",
+    "@typespec/compiler": "^1.2.0",
+    "@typespec/http": "^1.2.0",
+    "@typespec/rest": "^0.72.0 || >=0.73.0-dev <0.73.0",
     "concurrently": "^9.1.2",
-    "minimist": "^1.2.8",
+    "pathe": "^2.0.3",
     "prettier": "~3.5.3",
     "web-tree-sitter": "^0.25.4",
     "tree-sitter-c-sharp": "^0.23.0",

package/src/testing/scenario-test/code-block-expectation.test.ts

@@ -0,0 +1,95 @@
+import { d } from "@alloy-js/core/testing";
+import { beforeAll, describe, expect, it } from "vitest";
+import { getExcerptForQuery, parseCodeBlockHeading } from "./code-block-expectation.js";
+import {
+  createSnippetExtractor,
+  createTypeScriptExtractorConfig,
+  type SnippetExtractor,
+} from "./snippet-extractor.js";
+
+describe("parseCodeBlockHeading", () => {
+  it("parse whole file expectation", () => {
+    expect(parseCodeBlockHeading("ts path/to/file.ts")).toEqual({
+      lang: "ts",
+      file: "path/to/file.ts",
+    });
+  });
+
+  it("throws error when no file is provided", () => {
+    expect(() => parseCodeBlockHeading("ts")).toThrow(
+      'Invalid code block heading: "ts". Missing file path. Expected format: "<lang> <path>"',
+    );
+  });
+
+  it("parse parse with type and name", () => {
+    expect(parseCodeBlockHeading("ts path/to/file.ts interface foo")).toEqual({
+      lang: "ts",
+      file: "path/to/file.ts",
+      query: {
+        type: "interface",
+        name: "foo",
+      },
+    });
+  });
+
+  it("throws error when using type but no name is provided", () => {
+    expect(() => parseCodeBlockHeading("ts path/to/file.ts interface")).toThrow(
+      'Invalid code block heading: "ts path/to/file.ts interface". Missing name when using type. Expected format: "<lang> <path> [type] [name]"',
+    );
+  });
+});
+
+describe("getExcerptForQuery", () => {
+  let snippetExtractor: SnippetExtractor;
+  beforeAll(async () => {
+    const tsExtractorConfig = await createTypeScriptExtractorConfig();
+    snippetExtractor = createSnippetExtractor(tsExtractorConfig);
+  });
+
+  it("gets a whole file", async () => {
+    const expectation = {
+      lang: "ts",
+      file: "file.ts",
+    };
+    const outputs = {
+      "file.ts": d`
+        interface bar {
+        
+        }
+        interface foo {
+          bar: string;
+        }      
+      `,
+    };
+    const excerpt = getExcerptForQuery(snippetExtractor, expectation, outputs);
+    expect(excerpt).toBe(outputs["file.ts"]);
+  });
+
+  it("gets an interface for typescript", async () => {
+    const expectation = {
+      lang: "ts",
+      file: "file.ts",
+      query: {
+        type: "interface",
+        name: "foo",
+      },
+    };
+    const outputs = {
+      "file.ts": d`
+        interface bar {
+        
+        }
+
+        interface foo {
+          bar: string;
+        }
+      `,
+    };
+    const excerpt = getExcerptForQuery(snippetExtractor, expectation, outputs);
+    expect(excerpt).toBe(d`
+      interface foo {
+        bar: string;
+      }
+    `);
+  });
+});

package/src/testing/scenario-test/code-block-expectation.ts

@@ -0,0 +1,115 @@
+import type { SnippetExtractor } from "./snippet-extractor.js";
+
+export interface ElementQuery {
+  /** Type to query */
+  type: string;
+
+  /** Name of the type to query */
+  name: string;
+}
+
+export interface CodeBlockQuery {
+  /** Language */
+  lang: string;
+
+  /** File path */
+  file: string;
+
+  /** Query for content in the file */
+  query?: ElementQuery;
+}
+
+export interface CodeBlockExpectation extends CodeBlockQuery {
+  /** Expected content of the code block */
+  expected: string;
+}
+
+/**
+ * Parse a markdown code block following the expectation syntax
+ */
+export function parseCodeblockExpectation(heading: string, content: string): CodeBlockExpectation {
+  const query = parseCodeBlockHeading(heading);
+  return {
+    ...query,
+    expected: content,
+  };
+}
+
+/**
+ * Parse the codeblock heading for what it should validate.
+ * Expected format
+ * ```
+ * ts path/to/file.ts {type} {name}
+ * ```
+ */
+export function parseCodeBlockHeading(heading: string): CodeBlockQuery {
+  const [lang, file, type, name] = heading.split(" ");
+  if (!file) {
+    throw new Error(
+      `Invalid code block heading: "${heading}". Missing file path. Expected format: "<lang> <path>"`,
+    );
+  }
+
+  if (type && !name) {
+    throw new Error(
+      `Invalid code block heading: "${heading}". Missing name when using type. Expected format: "<lang> <path> [type] [name]"`,
+    );
+  }
+
+  return { lang, file, query: type ? { type, name } : undefined };
+}
+
+export function getExcerptForQuery(
+  snippetExtractor: SnippetExtractor,
+  expectation: CodeBlockQuery,
+  outputs: Record<string, string>,
+): string {
+  const content = outputs[expectation.file];
+
+  if (!content) {
+    throw new Error(
+      `File ${expectation.file} not found in emitted files:\n ${Object.keys(outputs).join("\n")}`,
+    );
+  }
+
+  return getExcerptInFile(snippetExtractor, expectation, content);
+}
+
+function getExcerptInFile(
+  snippetExtractor: SnippetExtractor,
+  expectation: CodeBlockQuery,
+  sourceFile: string,
+): string {
+  if (expectation.query) {
+    const excerpt = tryGetExcerptInFile(snippetExtractor, expectation.query, sourceFile);
+    if (!excerpt) {
+      throw new Error(
+        `Could not find ${expectation.query.type} "${expectation.query.name}" in file "${expectation.file}".`,
+      );
+    }
+    return excerpt;
+  } else {
+    return sourceFile;
+  }
+}
+
+function tryGetExcerptInFile(
+  snippetExtractor: SnippetExtractor,
+  query: ElementQuery,
+  sourceFile: string,
+): string | null {
+  switch (query.type) {
+    case "interface":
+      return snippetExtractor.getInterface(sourceFile, query.name);
+    case "type":
+      return snippetExtractor.getTypeAlias(sourceFile, query.name);
+    case "enum":
+      return snippetExtractor.getEnum(sourceFile, query.name);
+    case "function":
+      return snippetExtractor.getFunction(sourceFile, query.name);
+    case "class":
+      return snippetExtractor.getClass(sourceFile, query.name);
+    default:
+      throw new Error("Unsupported type in code block expectation: " + query.type);
+  }
+}