@typespec/compiler 0.52.0-dev.9 → 0.53.0-dev.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typespec/compiler",
-  "version": "0.52.0-dev.9",
+  "version": "0.53.0-dev.0",
   "description": "TypeSpec Compiler Preview",
   "author": "Microsoft Corporation",
   "license": "MIT",
@@ -73,24 +73,23 @@
   },
   "devDependencies": {
     "@types/babel__code-frame": "~7.0.6",
-    "@types/mocha": "~10.0.6",
     "@types/mustache": "~4.2.5",
     "@types/node": "~18.11.9",
     "@types/prompts": "~2.4.9",
     "@types/semver": "^7.5.6",
     "@types/yargs": "~17.0.32",
-    "@typespec/eslint-config-typespec": "~0.51.0 || >=0.52.0-dev <0.52.0",
-    "@typespec/internal-build-utils": "~0.51.0 || >=0.52.0-dev <0.52.0",
+    "@typespec/eslint-config-typespec": "~0.52.0 || >=0.53.0-dev <0.53.0",
+    "@typespec/internal-build-utils": "~0.52.0 || >=0.53.0-dev <0.53.0",
     "eslint": "^8.55.0",
     "grammarkdown": "~3.3.2",
-    "mocha": "~10.2.0",
-    "mocha-junit-reporter": "~2.2.1",
-    "mocha-multi-reporters": "~1.5.1",
+    "vitest": "^1.2.0",
+    "@vitest/coverage-v8": "^1.1.0",
+    "@vitest/ui": "~1.1.3",
     "c8": "~8.0.1",
     "prettier-plugin-organize-imports": "~3.2.4",
     "source-map-support": "~0.5.21",
     "rimraf": "~5.0.1",
-    "tmlanguage-generator": "~0.5.1 || >=0.6.0-dev <0.6.0",
+    "tmlanguage-generator": "~0.5.2 || >=0.6.0-dev <0.6.0",
     "typescript": "~5.3.3",
     "vscode-oniguruma": "~2.0.1",
     "vscode-textmate": "~9.0.0",
@@ -108,9 +107,10 @@
     "watch-tmlanguage": "node scripts/watch-tmlanguage.js",
     "generate-tmlanguage": "node scripts/generate-tmlanguage.js",
     "dogfood": "node scripts/dogfood.js",
-    "test": "mocha",
-    "test-official": "c8 mocha --forbid-only --reporter mocha-multi-reporters",
-    "e2e": "mocha --config ./.mocharc.e2e.yaml",
+    "test": "vitest run",
+    "test:ui": "vitest --ui",
+    "test-official": "vitest run --coverage --reporter=junit --reporter=default --no-file-parallelism",
+    "e2e": "vitest run --config ./vitest.config.e2e.ts",
     "gen-manifest": "node scripts/generate-manifest.js",
     "regen-nonascii": "node scripts/regen-nonascii.js",
     "fuzz": "node dist/test/manual/fuzz.js run",

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

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

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

@@ -1,5 +1,5 @@
 import { strictEqual } from "node:assert";
-import { describe, it } from "node:test";
+import { describe, it } from "vitest";
 import { emit } from "./test-host.js";
 
 describe("hello", () => {

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

@@ -4,11 +4,11 @@ import {
   createTestWrapper,
   expectDiagnosticEmpty,
 } from "@typespec/compiler/testing";
-import { TestLibrary } from "../src/testing/index.js";
+import { EmitterTsTestLibrary } from "../src/testing/index.js";
 
 export async function createEmitterTsTestHost() {
   return createTestHost({
-    libraries: [TestLibrary],
+    libraries: [EmitterTsTestLibrary],
   });
 }
 

package/templates/__snapshots__/library-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/__snapshots__/library-ts/lib/decorators.tsp

@@ -0,0 +1,12 @@
+import "../dist/src/decorators.js";
+
+using TypeSpec.Reflection;
+
+namespace LibraryTs;
+
+/**
+ * __Example Decorator__
+ * Provide an alternate name for an operation.
+ * @param name The alternate name.
+ */
+extern dec alternateName(target: Operation, name: valueof string);

package/templates/__snapshots__/library-ts/lib/main.tsp

@@ -0,0 +1 @@
+import "./decorators.tsp";

package/templates/__snapshots__/library-ts/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "library-ts",
+  "version": "0.1.0",
+  "type": "module",
+  "main": "dist/src/index.js",
+  "tspMain": "lib/main.tsp",
+  "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",
+    "@typespec/library-linter": "latest",
+    "eslint": "^8.45.0",
+    "prettier": "^3.0.3",
+    "typescript": "^5.3.3"
+  },
+  "scripts": {
+    "build": "tsc && npm run build:tsp",
+    "watch": "tsc --watch",
+    "build:tsp": "tsp compile . --warn-as-error --import @typespec/library-linter --no-emit",
+    "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/__snapshots__/library-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__/library-ts/src/decorators.ts

@@ -0,0 +1,33 @@
+import { DecoratorContext, Operation, Program } from "@typespec/compiler";
+import { StateKeys, reportDiagnostic } from "./lib.js";
+
+export const namespace = "LibraryTs";
+
+/**
+ * __Example implementation of the `@alternateName` decorator.__
+ *
+ * @param context Decorator context.
+ * @param target Decorator target. Must be an operation.
+ * @param name Alternate name.
+ */
+export function $alternateName(context: DecoratorContext, target: Operation, name: string) {
+  if (name === "banned") {
+    reportDiagnostic(context.program, {
+      code: "banned-alternate-name",
+      target: context.getArgumentTarget(0)!,
+      format: { name },
+    });
+  }
+  context.program.stateMap(StateKeys.alternateName).set(target, name);
+}
+
+/**
+ * __Example accessor for  the `@alternateName` decorator.__
+ *
+ * @param program TypeSpec program.
+ * @param target Decorator target. Must be an operation.
+ * @returns Altenate name if provided on the given operation or undefined
+ */
+export function getAlternateName(program: Program, target: Operation): string | undefined {
+  return program.stateMap(StateKeys.alternateName).get(target);
+}

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

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

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

@@ -0,0 +1,20 @@
+import { createTypeSpecLibrary, paramMessage } from "@typespec/compiler";
+
+export const $lib = createTypeSpecLibrary({
+  name: "library-ts",
+  // Define diagnostics for the library. This will provide a typed API to report diagnostic as well as a auto doc generation.
+  diagnostics: {
+    "banned-alternate-name": {
+      severity: "error",
+      messages: {
+        default: paramMessage`Banned alternate name "${"name"}".`,
+      },
+    },
+  },
+  // Defined state keys for storing metadata in decorator.
+  state: {
+    alternateName: { description: "alternateName" },
+  },
+});
+
+export const { reportDiagnostic, createDiagnostic, stateKeys: StateKeys } = $lib;

package/templates/__snapshots__/library-ts/src/linter.ts

@@ -0,0 +1,14 @@
+import { defineLinter } from "@typespec/compiler";
+import { noInterfaceRule } from "./rules/no-interfaces.rule.js";
+
+export const $linter = defineLinter({
+  rules: [noInterfaceRule],
+  ruleSets: {
+    recommended: {
+      enable: { [`library-ts/${noInterfaceRule.name}`]: true },
+    },
+    all: {
+      enable: { [`library-ts/${noInterfaceRule.name}`]: true },
+    },
+  },
+});

package/templates/__snapshots__/library-ts/src/rules/no-interfaces.rule.ts

@@ -0,0 +1,19 @@
+import { createRule } from "@typespec/compiler";
+
+export const noInterfaceRule = createRule({
+  name: "no-interface",
+  severity: "warning",
+  description: "Make sure interface are not used.",
+  messages: {
+    default: "Interface shouldn't be used with this library. Keep operations at the root.",
+  },
+  create: (context) => {
+    return {
+      interface: (iface) => {
+        context.reportDiagnostic({
+          target: iface,
+        });
+      },
+    };
+  },
+});

package/templates/{emitter-ts → __snapshots__/library-ts}/src/testing/index.ts

@@ -2,7 +2,7 @@ import { resolvePath } from "@typespec/compiler";
 import { createTestLibrary, TypeSpecTestLibrary } from "@typespec/compiler/testing";
 import { fileURLToPath } from "url";
 
-export const TestLibrary: TypeSpecTestLibrary = createTestLibrary({
-  name: "{{name}}",
+export const LibraryTsTestLibrary: TypeSpecTestLibrary = createTestLibrary({
+  name: "library-ts",
   packageRoot: resolvePath(fileURLToPath(import.meta.url), "../../../../"),
 });

package/templates/__snapshots__/library-ts/test/decorators.test.ts

@@ -0,0 +1,48 @@
+import { strictEqual } from "node:assert";
+import { describe, it, beforeEach } from "node:test";
+import { Operation } from "@typespec/compiler";
+import { BasicTestRunner, expectDiagnostics, extractCursor } from "@typespec/compiler/testing";
+import { getAlternateName } from "../src/decorators.js";
+import { createLibraryTsTestRunner } from "./test-host.js";
+
+describe("decorators", () => {
+  let runner: BasicTestRunner;
+
+  beforeEach(async () => {
+    runner = await createLibraryTsTestRunner();
+  })
+
+  describe("@alternateName", () => {
+    it("set alternate name on operation", async () => {
+      const { test } = (await runner.compile(
+        `@alternateName("bar") @test op test(): void;`
+      )) as { test: Operation };
+      strictEqual(getAlternateName(runner.program, test), "bar");
+    });
+
+    it("emit diagnostic if not used on an operation", async () => {
+      const diagnostics = await runner.diagnose(
+        `@alternateName("bar") model Test {}`
+      );
+      expectDiagnostics(diagnostics, {
+        severity: "error",
+        code: "decorator-wrong-target",
+        message: "Cannot apply @alternateName decorator to Test since it is not assignable to Operation"
+      })
+    });
+
+
+    it("emit diagnostic if using banned name", async () => {
+      const {pos, source} = extractCursor(`@alternateName(┆"banned") op test(): void;`)
+      const diagnostics = await runner.diagnose(
+        source
+      );
+      expectDiagnostics(diagnostics, {
+        severity: "error",
+        code: "library-ts/banned-alternate-name",
+        message: `Banned alternate name "banned".`,
+        pos: pos + runner.autoCodeOffset
+      })
+    });
+  });
+});

package/templates/__snapshots__/library-ts/test/rules/no-interfaces.rule.test.ts

@@ -0,0 +1,29 @@
+import {
+  LinterRuleTester,
+  createLinterRuleTester,
+  createTestRunner,
+} from "@typespec/compiler/testing";
+import { beforeEach, describe, it } from "node:test";
+import { noInterfaceRule } from "../../src/rules/no-interfaces.rule.js";
+
+describe("noInterfaceRule", () => {
+  let ruleTester: LinterRuleTester;
+
+  beforeEach(async () => {
+    const runner = await createTestRunner();
+    ruleTester = createLinterRuleTester(runner, noInterfaceRule, "library-ts");
+  });
+
+  describe("models", () => {
+    it("emit diagnostics if using interfaces", async () => {
+      await ruleTester.expect(`interface Test {}`).toEmitDiagnostics({
+        code: "library-ts/no-interface",
+        message: "Interface shouldn't be used with this library. Keep operations at the root.",
+      });
+    });
+
+    it("should be valid if operation is at the root", async () => {
+      await ruleTester.expect(`op test(): void;`).toBeValid();
+    });
+  });
+});

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

@@ -0,0 +1,17 @@
+import { createTestHost, createTestWrapper } from "@typespec/compiler/testing";
+import { LibraryTsTestLibrary } from "../src/testing/index.js";
+
+export async function createLibraryTsTestHost() {
+  return createTestHost({
+    libraries: [LibraryTsTestLibrary],
+  });
+}
+
+export async function createLibraryTsTestRunner() {
+  const host = await createLibraryTsTestHost();
+
+  return createTestWrapper(host, {
+    autoUsings: ["LibraryTs"]
+  });
+}
+

package/templates/__snapshots__/library-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/src/testing/index.ts.mu

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

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

@@ -1,5 +1,5 @@
 import { strictEqual } from "node:assert";
-import { describe, it } from "node:test";
+import { describe, it } from "vitest";
 import { emit } from "./test-host.js";
 
 describe("hello", () => {

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

@@ -4,11 +4,11 @@ import {
   createTestWrapper,
   expectDiagnosticEmpty,
 } from "@typespec/compiler/testing";
-import { TestLibrary } from "../src/testing/index.js";
+import { {{#casing.pascalCase}}{{name}}{{/casing.pascalCase}}TestLibrary } from "../src/testing/index.js";
 
 export async function create{{#casing.pascalCase}}{{name}}{{/casing.pascalCase}}TestHost() {
   return createTestHost({
-    libraries: [TestLibrary],
+    libraries: [{{#casing.pascalCase}}{{name}}{{/casing.pascalCase}}TestLibrary],
   });
 }
 

package/templates/library-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/library-ts/lib/decorators.tsp.mu

@@ -0,0 +1,12 @@
+import "../dist/src/decorators.js";
+
+using TypeSpec.Reflection;
+
+namespace {{#casing.pascalCase}}{{name}}{{/casing.pascalCase}};
+
+/**
+ * __Example Decorator__
+ * Provide an alternate name for an operation.
+ * @param name The alternate name.
+ */
+extern dec alternateName(target: Operation, name: valueof string);

package/templates/library-ts/lib/main.tsp

@@ -0,0 +1 @@
+import "./decorators.tsp";

package/templates/library-ts/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "{{name}}",
+  "version": "0.1.0",
+  "type": "module",
+  "main": "dist/src/index.js",
+  "tspMain": "lib/main.tsp",
+  "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",
+    "@typespec/library-linter": "latest",
+    "eslint": "^8.45.0",
+    "prettier": "^3.0.3",
+    "typescript": "^5.3.3"
+  },
+  "scripts": {
+    "build": "tsc && npm run build:tsp",
+    "watch": "tsc --watch",
+    "build:tsp": "tsp compile . --warn-as-error --import @typespec/library-linter --no-emit",
+    "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/library-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/library-ts/src/decorators.ts

@@ -0,0 +1,33 @@
+import { DecoratorContext, Operation, Program } from "@typespec/compiler";
+import { StateKeys, reportDiagnostic } from "./lib.js";
+
+export const namespace = "{{#casing.pascalCase}}{{name}}{{/casing.pascalCase}}";
+
+/**
+ * __Example implementation of the `@alternateName` decorator.__
+ *
+ * @param context Decorator context.
+ * @param target Decorator target. Must be an operation.
+ * @param name Alternate name.
+ */
+export function $alternateName(context: DecoratorContext, target: Operation, name: string) {
+  if (name === "banned") {
+    reportDiagnostic(context.program, {
+      code: "banned-alternate-name",
+      target: context.getArgumentTarget(0)!,
+      format: { name },
+    });
+  }
+  context.program.stateMap(StateKeys.alternateName).set(target, name);
+}
+
+/**
+ * __Example accessor for  the `@alternateName` decorator.__
+ *
+ * @param program TypeSpec program.
+ * @param target Decorator target. Must be an operation.
+ * @returns Altenate name if provided on the given operation or undefined
+ */
+export function getAlternateName(program: Program, target: Operation): string | undefined {
+  return program.stateMap(StateKeys.alternateName).get(target);
+}

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

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

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

@@ -0,0 +1,20 @@
+import { createTypeSpecLibrary, paramMessage } from "@typespec/compiler";
+
+export const $lib = createTypeSpecLibrary({
+  name: "{{name}}",
+  // Define diagnostics for the library. This will provide a typed API to report diagnostic as well as a auto doc generation.
+  diagnostics: {
+    "banned-alternate-name": {
+      severity: "error",
+      messages: {
+        default: paramMessage`Banned alternate name "${"name"}".`,
+      },
+    },
+  },
+  // Defined state keys for storing metadata in decorator.
+  state: {
+    alternateName: { description: "alternateName" },
+  },
+});
+
+export const { reportDiagnostic, createDiagnostic, stateKeys: StateKeys } = $lib;

package/templates/library-ts/src/linter.ts

@@ -0,0 +1,14 @@
+import { defineLinter } from "@typespec/compiler";
+import { noInterfaceRule } from "./rules/no-interfaces.rule.js";
+
+export const $linter = defineLinter({
+  rules: [noInterfaceRule],
+  ruleSets: {
+    recommended: {
+      enable: { [`{{name}}/${noInterfaceRule.name}`]: true },
+    },
+    all: {
+      enable: { [`{{name}}/${noInterfaceRule.name}`]: true },
+    },
+  },
+});

package/templates/library-ts/src/rules/no-interfaces.rule.ts

@@ -0,0 +1,19 @@
+import { createRule } from "@typespec/compiler";
+
+export const noInterfaceRule = createRule({
+  name: "no-interface",
+  severity: "warning",
+  description: "Make sure interface are not used.",
+  messages: {
+    default: "Interface shouldn't be used with this library. Keep operations at the root.",
+  },
+  create: (context) => {
+    return {
+      interface: (iface) => {
+        context.reportDiagnostic({
+          target: iface,
+        });
+      },
+    };
+  },
+});

package/templates/library-ts/src/testing/index.ts.mu

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