Merge branch 'main' into github-tseslint-typechecked

Author: mikeharder

.github/eslint.config.js

@@ -18,4 +18,7 @@ export default defineConfig(eslint.configs.recommended, tseslint.configs.recomme
       tsconfigRootDir: import.meta.dirname,
     },
   },
+  {
+    ignores: ["coverage/**", "shared/coverage/**"],
+  },
 });

.github/package.json

@@ -39,6 +39,7 @@
     "vitest": "^3.2.4"
   },
   "scripts": {
+    "check": "npm run lint && npm run format:check && npm run test:ci",
     "lint": "npm run lint:eslint && npm run lint:tsc",
     "lint:eslint": "cross-env DEBUG=eslint:eslint eslint",
     "lint:tsc": "tsc --build --verbose",

.github/shared/eslint.config.js

@@ -18,4 +18,7 @@ export default defineConfig(eslint.configs.recommended, tseslint.configs.recomme
       tsconfigRootDir: import.meta.dirname,
     },
   },
-});
+  {
+    ignores: ["coverage/**"],
+  },
+);

.github/shared/package.json

@@ -60,6 +60,7 @@
     "vitest": "^3.2.4"
   },
   "scripts": {
+    "check": "npm run lint && npm run format:check && npm run test:ci",
     "lint": "npm run lint:eslint && npm run lint:tsc",
     "lint:eslint": "cross-env DEBUG=eslint:eslint eslint",
     "lint:tsc": "tsc --build --verbose",

.github/shared/src/sdk-types.js

@@ -8,13 +8,25 @@ const SdkNameSchema = z.enum([
   "azure-sdk-for-python",
 ]);
 /**
- * @typedef {import("zod").infer<typeof SdkNameSchema>} SdkName
+ * Represents supported SDK language identifiers.
+ *
+ * @readonly
+ * @enum {"azure-sdk-for-go" | "azure-sdk-for-java" | "azure-sdk-for-js" | "azure-sdk-for-net" | "azure-sdk-for-python"}
  */
+export const SdkName = Object.freeze({
+  Go: "azure-sdk-for-go",
+  Java: "azure-sdk-for-java",
+  Js: "azure-sdk-for-js",
+  Net: "azure-sdk-for-net",
+  Python: "azure-sdk-for-python",
+});
+/** @type {import("zod").ZodType<SdkName>} */
+export const SdkNameSchema = z.enum(Object.values(SdkName));
 
 /*
  * Data for the API view request.
  */
-const APIViewRequestDataSchema = z.object({ packageName: z.string(), filePath: z.string() });
+export const APIViewRequestDataSchema = z.object({ packageName: z.string(), filePath: z.string() });
 /**
  * @typedef {import("zod").infer<typeof APIViewRequestDataSchema>} APIViewRequestData
  */

.github/shared/test/sdk-types.js

@@ -1,9 +1,12 @@
+import { SdkName } from "../src/sdk-types.js";
+
 /**
  * @typedef {import("../src/sdk-types.js").SpecGenSdkArtifactInfo} SpecGenSdkArtifactInfo
  */
 
 /**
  * Create a mock SpecGenSdkArtifactInfo, filling unspecified properties with defaults.
+ *
  * @param {Partial<import("../src/sdk-types.js").SpecGenSdkArtifactInfo>} [overrides]
  * @returns {SpecGenSdkArtifactInfo}
  */
@@ -13,7 +16,7 @@ export function createMockSpecGenSdkArtifactInfo(overrides = {}) {
     apiViewRequestData: [],
     headSha: "abc123",
     isSpecGenSdkCheckRequired: true,
-    language: "azure-sdk-for-go",
+    language: SdkName.Go,
     result: "test result",
   };
 

.github/shared/tsconfig.json

@@ -8,4 +8,5 @@
     "incremental": false,
     "noEmit": true,
   },
+  "exclude": ["coverage"],
 }

.github/tsconfig.json

@@ -8,4 +8,5 @@
     "incremental": false,
     "noEmit": true,
   },
+  "exclude": ["coverage", "shared/coverage"],
 }

.github/workflows/test/spec-gen-sdk-status.test.js

@@ -1,5 +1,6 @@
 import fs from "fs";
 import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
+import { SdkName } from "../../shared/src/sdk-types.js";
 import { createMockSpecGenSdkArtifactInfo } from "../../shared/test/sdk-types.js";
 import * as artifacts from "../src/artifacts.js";
 import * as github from "../src/github.js";
@@ -35,7 +36,7 @@ describe("spec-gen-sdk-status", () => {
         return Promise.resolve({
           artifactData: JSON.stringify(
             createMockSpecGenSdkArtifactInfo({
-              language: "azure-sdk-for-go",
+              language: SdkName.Go,
               result: "succeeded",
               isSpecGenSdkCheckRequired: true,
             }),
@@ -127,7 +128,7 @@ describe("spec-gen-sdk-status", () => {
     getAzurePipelineArtifactMock.mockResolvedValue({
       artifactData: JSON.stringify(
         createMockSpecGenSdkArtifactInfo({
-          language: "azure-sdk-for-go",
+          language: SdkName.Go,
           result: "succeeded",
           isSpecGenSdkCheckRequired: true,
         }),
@@ -186,7 +187,7 @@ describe("spec-gen-sdk-status", () => {
         return {
           artifactData: JSON.stringify(
             createMockSpecGenSdkArtifactInfo({
-              language: "azure-sdk-for-go",
+              language: SdkName.Go,
               result: "succeeded",
               isSpecGenSdkCheckRequired: true,
             }),
@@ -196,7 +197,7 @@ describe("spec-gen-sdk-status", () => {
         return {
           artifactData: JSON.stringify(
             createMockSpecGenSdkArtifactInfo({
-              language: "azure-sdk-for-java",
+              language: SdkName.Java,
               result: "failed",
               isSpecGenSdkCheckRequired: true,
             }),
@@ -322,7 +323,7 @@ describe("spec-gen-sdk-status", () => {
         return {
           artifactData: JSON.stringify(
             createMockSpecGenSdkArtifactInfo({
-              language: "azure-sdk-for-go",
+              language: SdkName.Go,
               result: "succeeded",
               isSpecGenSdkCheckRequired: true,
             }),
@@ -332,7 +333,7 @@ describe("spec-gen-sdk-status", () => {
         return {
           artifactData: JSON.stringify(
             createMockSpecGenSdkArtifactInfo({
-              language: "azure-sdk-for-java",
+              language: SdkName.Java,
               result: "failed",
               isSpecGenSdkCheckRequired: false, // Not required
             }),

README.md

@@ -22,6 +22,13 @@ External Contributors can read [Getting Started with OpenAPI Specifications](htt
 
 See [aka.ms/azsdk/spec-dirs](https://aka.ms/azsdk/spec-dirs).
 
+## Examples
+
+These examples provide a starting point for how a library should be structured, as well as the expected options that libraries should use:
+
+* Data plane: [https://aka.ms/azsdk/tspconfig-sample-dpg](https://aka.ms/azsdk/tspconfig-sample-dpg)
+* Management plane (ARM): [https://aka.ms/azsdk/tspconfig-sample-mpg](https://aka.ms/azsdk/tspconfig-sample-mpg)
+
 ## Next steps
 
 The next step in the process after a spec is completed is to generate SDKs and API reference documentation. If you're a Microsoft employee, go to the [Azure SDK - Internal Wiki](https://aka.ms/jointhesdk) for more information.