@typespec/compiler 0.52.0-dev.3 → 0.52.0-dev.6

package/templates/__snapshots__/emitter-ts/prettierrc.yaml

@@ -0,0 +1,8 @@
+trailingComma: "all"
+printWidth: 120
+quoteProps: "consistent"
+endOfLine: lf
+arrowParens: always
+plugins:
+  - "./node_modules/@typespec/prettier-plugin-typespec/dist/index.js"
+overrides: [{ "files": "*.tsp", "options": { "parser": "typespec" } }]

package/templates/__snapshots__/emitter-ts/src/emitter.ts

@@ -0,0 +1,10 @@
+import { EmitContext, emitFile, resolvePath } from "@typespec/compiler";
+
+export async function $onEmit(context: EmitContext) {
+  if (!context.program.compilerOptions.noEmit) {
+    await emitFile(context.program, {
+      path: resolvePath(context.emitterOutputDir, "output.txt"),
+      content: "Hello world\n",
+    });
+  }
+}

package/templates/__snapshots__/emitter-ts/src/index.ts

@@ -0,0 +1,2 @@
+export { $onEmit } from "./emitter.js";
+export { $lib } from "./lib.js";

package/templates/__snapshots__/emitter-ts/src/lib.ts

@@ -0,0 +1,8 @@
+import { createTypeSpecLibrary } from "@typespec/compiler";
+
+export const $lib = createTypeSpecLibrary({
+  name: "emitter-ts",
+  diagnostics: {},
+});
+
+export const { reportDiagnostic, createDiagnostic } = $lib;

package/templates/__snapshots__/emitter-ts/src/testing/index.ts

@@ -0,0 +1,8 @@
+import { resolvePath } from "@typespec/compiler";
+import { createTestLibrary, TypeSpecTestLibrary } from "@typespec/compiler/testing";
+import { fileURLToPath } from "url";
+
+export const TestLibrary: TypeSpecTestLibrary = createTestLibrary({
+  name: "emitter-ts",
+  packageRoot: resolvePath(fileURLToPath(import.meta.url), "../../../../"),
+});

package/templates/__snapshots__/emitter-ts/test/hello.test.ts

@@ -0,0 +1,10 @@
+import { strictEqual } from "node:assert";
+import { describe, it } from "node:test";
+import { emit } from "./test-host.js";
+
+describe("hello", () => {
+  it("emit output.txt with content hello world", async () => {
+    const results = await emit(`op test(): void;`);
+    strictEqual(results["output.txt"], "Hello world\n");
+  });
+});

package/templates/__snapshots__/emitter-ts/test/test-host.ts

@@ -0,0 +1,47 @@
+import { Diagnostic, resolvePath } from "@typespec/compiler";
+import {
+  createTestHost,
+  createTestWrapper,
+  expectDiagnosticEmpty,
+} from "@typespec/compiler/testing";
+import { TestLibrary } from "../src/testing/index.js";
+
+export async function createEmitterTsTestHost() {
+  return createTestHost({
+    libraries: [TestLibrary],
+  });
+}
+
+export async function createEmitterTsTestRunner() {
+  const host = await createEmitterTsTestHost();
+
+  return createTestWrapper(host, {
+    compilerOptions: {
+      noEmit: false,
+      emit: ["emitter-ts"],
+    },
+  });
+}
+
+export async function emitWithDiagnostics(
+  code: string
+): Promise<[Record<string, string>, readonly Diagnostic[]]> {
+  const runner = await createEmitterTsTestRunner();
+  await runner.compileAndDiagnose(code, {
+    outputDir: "tsp-output",
+  });
+  const emitterOutputDir = "./tsp-output/emitter-ts";
+  const files = await runner.program.host.readDir(emitterOutputDir);
+
+  const result: Record<string, string> = {};
+  for (const file of files) {
+    result[file] = (await runner.program.host.readFile(resolvePath(emitterOutputDir, file))).text;
+  }
+  return [result, runner.program.diagnostics];
+}
+
+export async function emit(code: string): Promise<Record<string, string>> {
+  const [result, diagnostics] = await emitWithDiagnostics(code);
+  expectDiagnosticEmpty(diagnostics);
+  return result;
+}

package/templates/__snapshots__/emitter-ts/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "useDefineForClassFields": true,
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "lib": ["ES2022"],
+    "rootDir": ".",
+    "outDir": "dist",
+    "sourceMap": true,
+    "declaration": true,
+
+    /* Linting */
+    "strict": true
+  },
+  "include": ["src", "test"]
+}

package/templates/emitter-ts/.eslintrc.yml

@@ -0,0 +1,14 @@
+root: true
+env:
+  es2021: true
+  node: true
+extends:
+  - eslint:recommended
+  - plugin:@typescript-eslint/recommended
+parser: "@typescript-eslint/parser"
+parserOptions:
+  ecmaVersion: latest
+  sourceType: module
+plugins:
+  - "@typescript-eslint"
+rules: {}

package/templates/emitter-ts/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "{{name}}",
+  "version": "0.1.0",
+  "type": "module",
+  "main": "dist/src/index.js",
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "default": "./dist/src/index.js"
+    },
+    "./testing": {
+      "types": "./dist/src/testing/index.d.ts",
+      "default": "./dist/src/testing/index.js"
+    }
+  },
+  "dependencies": {
+    "@typespec/compiler": "latest"
+  },
+  "devDependencies": {
+    "@types/node": "latest",
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.0.0",
+    "eslint": "^8.45.0",
+    "typescript": "^5.3.3",
+    "prettier": "^3.0.3"
+  },
+  "scripts": {
+    "build": "tsc",
+    "watch": "tsc --watch",
+    "test": "node --test ./dist/test/",
+    "lint": "eslint src/ test/ --report-unused-disable-directives --max-warnings=0",
+    "lint:fix": "eslint . --report-unused-disable-directives --fix",
+    "format": "prettier .  --write",
+    "format:check": "prettier --check ."
+  },
+  "private": true
+}

package/templates/emitter-ts/prettierrc.yaml

@@ -0,0 +1,8 @@
+trailingComma: "all"
+printWidth: 120
+quoteProps: "consistent"
+endOfLine: lf
+arrowParens: always
+plugins:
+  - "./node_modules/@typespec/prettier-plugin-typespec/dist/index.js"
+overrides: [{ "files": "*.tsp", "options": { "parser": "typespec" } }]

package/templates/emitter-ts/src/emitter.ts

@@ -0,0 +1,10 @@
+import { EmitContext, emitFile, resolvePath } from "@typespec/compiler";
+
+export async function $onEmit(context: EmitContext) {
+  if (!context.program.compilerOptions.noEmit) {
+    await emitFile(context.program, {
+      path: resolvePath(context.emitterOutputDir, "output.txt"),
+      content: "Hello world\n",
+    });
+  }
+}

package/templates/emitter-ts/src/index.ts

@@ -0,0 +1,2 @@
+export { $onEmit } from "./emitter.js";
+export { $lib } from "./lib.js";

package/templates/emitter-ts/src/lib.ts

@@ -0,0 +1,8 @@
+import { createTypeSpecLibrary } from "@typespec/compiler";
+
+export const $lib = createTypeSpecLibrary({
+  name: "{{name}}",
+  diagnostics: {},
+});
+
+export const { reportDiagnostic, createDiagnostic } = $lib;

package/templates/emitter-ts/src/testing/index.ts

@@ -0,0 +1,8 @@
+import { resolvePath } from "@typespec/compiler";
+import { createTestLibrary, TypeSpecTestLibrary } from "@typespec/compiler/testing";
+import { fileURLToPath } from "url";
+
+export const TestLibrary: TypeSpecTestLibrary = createTestLibrary({
+  name: "{{name}}",
+  packageRoot: resolvePath(fileURLToPath(import.meta.url), "../../../../"),
+});

package/templates/emitter-ts/test/hello.test.ts

@@ -0,0 +1,10 @@
+import { strictEqual } from "node:assert";
+import { describe, it } from "node:test";
+import { emit } from "./test-host.js";
+
+describe("hello", () => {
+  it("emit output.txt with content hello world", async () => {
+    const results = await emit(`op test(): void;`);
+    strictEqual(results["output.txt"], "Hello world\n");
+  });
+});

package/templates/emitter-ts/test/test-host.ts.mu

@@ -0,0 +1,47 @@
+import { Diagnostic, resolvePath } from "@typespec/compiler";
+import {
+  createTestHost,
+  createTestWrapper,
+  expectDiagnosticEmpty,
+} from "@typespec/compiler/testing";
+import { TestLibrary } from "../src/testing/index.js";
+
+export async function create{{#casing.pascalCase}}{{name}}{{/casing.pascalCase}}TestHost() {
+  return createTestHost({
+    libraries: [TestLibrary],
+  });
+}
+
+export async function create{{#casing.pascalCase}}{{name}}{{/casing.pascalCase}}TestRunner() {
+  const host = await create{{#casing.pascalCase}}{{name}}{{/casing.pascalCase}}TestHost();
+
+  return createTestWrapper(host, {
+    compilerOptions: {
+      noEmit: false,
+      emit: ["{{name}}"],
+    },
+  });
+}
+
+export async function emitWithDiagnostics(
+  code: string
+): Promise<[Record<string, string>, readonly Diagnostic[]]> {
+  const runner = await create{{#casing.pascalCase}}{{name}}{{/casing.pascalCase}}TestRunner();
+  await runner.compileAndDiagnose(code, {
+    outputDir: "tsp-output",
+  });
+  const emitterOutputDir = "./tsp-output/{{name}}";
+  const files = await runner.program.host.readDir(emitterOutputDir);
+
+  const result: Record<string, string> = {};
+  for (const file of files) {
+    result[file] = (await runner.program.host.readFile(resolvePath(emitterOutputDir, file))).text;
+  }
+  return [result, runner.program.diagnostics];
+}
+
+export async function emit(code: string): Promise<Record<string, string>> {
+  const [result, diagnostics] = await emitWithDiagnostics(code);
+  expectDiagnosticEmpty(diagnostics);
+  return result;
+}

package/templates/emitter-ts/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "useDefineForClassFields": true,
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "lib": ["ES2022"],
+    "rootDir": ".",
+    "outDir": "dist",
+    "sourceMap": true,
+    "declaration": true,
+
+    /* Linting */
+    "strict": true
+  },
+  "include": ["src", "test"]
+}

package/templates/scaffolding.json

@@ -0,0 +1,79 @@
+{
+  "empty": {
+    "title": "Empty project",
+    "description": "Create an empty project.",
+    "libraries": [],
+    "compilerVersion": "0.51.0"
+  },
+  "rest": {
+    "title": "Generic Rest API",
+    "description": "Create a project representing a generic Rest API",
+    "compilerVersion": "0.51.0",
+    "libraries": [
+      "@typespec/http",
+      "@typespec/rest",
+      "@typespec/openapi3"
+    ],
+    "config": {
+      "emit": [
+        "@typespec/openapi3"
+      ]
+    }
+  },
+  "emitter-ts": {
+    "title": "TypeSpec Emitter (With TypeScript)",
+    "description": "Create a new package that will be emitting typespec",
+    "compilerVersion": "0.51.0",
+    "libraries": [],
+    "files": [
+      {
+        "destination": "main.tsp",
+        "skipGeneration": true
+      },
+      {
+        "destination": "tspconfig.yaml",
+        "skipGeneration": true
+      },
+      {
+        "path": "emitter-ts/.eslintrc.yml",
+        "destination": ".eslintrc.yml"
+      },
+      {
+        "path": "emitter-ts/package.json",
+        "destination": "package.json"
+      },
+      {
+        "path": "emitter-ts/prettierrc.yaml",
+        "destination": "prettierrc.yaml"
+      },
+      {
+        "path": "emitter-ts/src/emitter.ts",
+        "destination": "src/emitter.ts"
+      },
+      {
+        "path": "emitter-ts/src/index.ts",
+        "destination": "src/index.ts"
+      },
+      {
+        "path": "emitter-ts/src/lib.ts",
+        "destination": "src/lib.ts"
+      },
+      {
+        "path": "emitter-ts/src/testing/index.ts",
+        "destination": "src/testing/index.ts"
+      },
+      {
+        "path": "emitter-ts/test/hello.test.ts",
+        "destination": "test/hello.test.ts"
+      },
+      {
+        "path": "emitter-ts/test/test-host.ts.mu",
+        "destination": "test/test-host.ts"
+      },
+      {
+        "path": "emitter-ts/tsconfig.json",
+        "destination": "tsconfig.json"
+      }
+    ]
+  }
+}