[tsp-client] Prefer emitter specific service-dir if specified (#8492)

* prefer emitter specific service-dir

* update package version and changelog

* update code

* add tests

---------

Co-authored-by: Catalina Peralta <caperal@microsoft.com>

Author: catalinaperalta

tools/tsp-client/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release
 
+## 2024-06-21 - 0.9.0
+
+- Prefer the `service-dir` parameter in the emitter configurations in tspconfig.yaml if specified.
+
 ## 2024-06-07 - 0.8.1
 
 - Normalize and clean up the directory property in tsp-location.yaml.

tools/tsp-client/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure-tools/typespec-client-generator-cli",
-  "version": "0.8.1",
+  "version": "0.9.0",
   "description": "A tool to generate Azure SDKs from TypeSpec",
   "main": "dist/index.js",
   "homepage": "https://github.com/Azure/azure-sdk-tools/tree/main/tools/tsp-client#readme",

tools/tsp-client/package.json

@@ -8,7 +8,7 @@ import { addSpecFiles, checkoutCommit, cloneRepo, getRepoRoot, sparseCheckout }
 import { doesFileExist } from "./network.js";
 import { parse as parseYaml } from "yaml";
 import { joinPaths, normalizePath, resolvePath } from "@typespec/compiler";
-import { formatAdditionalDirectories, getAdditionalDirectoryName, makeSparseSpecDir } from "./utils.js";
+import { formatAdditionalDirectories, getAdditionalDirectoryName, getServiceDir, makeSparseSpecDir } from "./utils.js";
 import { resolve } from "node:path";
 import { config as dotenvConfig } from "dotenv";
 
@@ -51,11 +51,7 @@ async function sdkInit(
       throw new Error(`tspconfig.yaml is empty at ${tspConfigPath}`);
     }
     const configYaml = parseYaml(data);
-    const serviceDir = configYaml?.parameters?.["service-dir"]?.default;
-    if (!serviceDir) {
-      throw new Error(`Parameter service-dir is not defined correctly in tspconfig.yaml. Please refer to https://github.com/Azure/azure-rest-api-specs/blob/main/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml for the right schema.`)
-    }
-    Logger.debug(`Service directory: ${serviceDir}`)
+    const serviceDir = getServiceDir(configYaml, emitter);
     const packageDir: string | undefined = configYaml?.options?.[emitter]?.["package-dir"];
     if (!packageDir) {
       throw new Error(`Missing package-dir in ${emitter} options of tspconfig.yaml. Please refer to https://github.com/Azure/azure-rest-api-specs/blob/main/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml for the right schema.`);
@@ -84,11 +80,7 @@ async function sdkInit(
       throw new Error(`tspconfig.yaml is empty at ${config}`);
     }
     const configYaml = parseYaml(data);
-    const serviceDir = configYaml?.parameters?.["service-dir"]?.default;
-    if (!serviceDir) {
-      throw new Error(`Parameter service-dir is not defined correctly in tspconfig.yaml. Please refer to https://github.com/Azure/azure-rest-api-specs/blob/main/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml for the right schema.`)
-    }
-    Logger.debug(`Service directory: ${serviceDir}`)
+    const serviceDir = getServiceDir(configYaml, emitter);
     const additionalDirOutput = formatAdditionalDirectories(configYaml?.parameters?.dependencies?.additionalDirectories);
     const packageDir = configYaml?.options?.[emitter]?.["package-dir"];
     if (!packageDir) {

tools/tsp-client/src/index.ts

@@ -1,6 +1,7 @@
 import { joinPaths, normalizeSlashes } from "@typespec/compiler";
 import { randomUUID } from "node:crypto";
 import { mkdir } from "node:fs/promises";
+import { Logger } from "./log.js";
 
 export function formatAdditionalDirectories(additionalDirectories?: string[]): string {
     let additionalDirOutput = "";
@@ -27,3 +28,14 @@ export async function makeSparseSpecDir(repoRoot: string): Promise<string> {
     await mkdir(spareSpecPath, { recursive: true });
     return spareSpecPath;
 }
+
+export function getServiceDir(configYaml: any, emitter: string): string {
+    // Check if service-dir is defined in the emitter specific configurations in tspconfig.yaml.
+    // Default to the top level service-dir parameter in tspconfig.yaml.
+    const serviceDir = configYaml?.options?.[emitter]?.["service-dir"] ?? configYaml?.parameters?.["service-dir"]?.default;
+    if (!serviceDir) {
+      throw new Error(`Parameter service-dir is not defined correctly in tspconfig.yaml. Please refer to https://github.com/Azure/azure-rest-api-specs/blob/main/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml for the right schema.`)
+    }
+    Logger.debug(`Service directory: ${serviceDir}`)
+    return serviceDir;
+}

tools/tsp-client/src/utils.ts

@@ -0,0 +1,39 @@
+parameters:
+  "service-dir":
+    default: "sdk/contosowidgetmanager"
+  "dependencies":
+    "additionalDirectories":
+      - "specification/contosowidgetmanager/Contoso.WidgetManager.Shared/"
+    default: ""
+emit:
+  - "@azure-tools/typespec-autorest"
+linter:
+  extends:
+    - "@azure-tools/typespec-azure-rulesets/data-plane"
+options:
+  "@azure-tools/typespec-autorest":
+    azure-resource-provider-folder: "data-plane"
+    emit-lro-options: "none"
+    emitter-output-dir: "{project-root}/.."
+    examples-directory: "examples"
+    output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/widgets.json"
+  "@azure-tools/typespec-python":
+    package-dir: "azure-contoso-widgetmanager"
+    package-name: "{package-dir}"
+    flavor: azure
+  "@azure-tools/typespec-csharp":
+    package-dir: "Azure.Template.Contoso"
+    clear-output-folder: true
+    model-namespace: false
+    namespace: "{package-dir}"
+    flavor: azure
+  "@azure-tools/typespec-ts":
+    service-dir: "sdk/contosowidgetmanager/widget"
+    package-dir: "contosowidgetmanager-rest"
+    packageDetails:
+      name: "@azure-rest/contoso-widgetmanager-rest"
+    flavor: azure
+  "@azure-tools/typespec-java":
+    package-dir: "azure-contoso-widgetmanager"
+    namespace: com.azure.contoso.widgetmanager
+    flavor: azure

tools/tsp-client/test/examples/tspconfig-custom-service-dir.yaml

@@ -0,0 +1,21 @@
+import { describe, it } from "node:test";
+import { getServiceDir } from "../src/utils.js";
+import { parse as parseYaml } from "yaml";
+import { assert } from "chai";
+import { readFile } from "node:fs/promises";
+
+describe("get the right service dir from tspconfig.yaml", function () {
+  it("Get custom emitter service-dir", async function () {
+    const data = await readFile("./test/examples/tspconfig-custom-service-dir.yaml", "utf8");
+    const configYaml = parseYaml(data);
+    const serviceDir = getServiceDir(configYaml, "@azure-tools/typespec-ts");
+    assert.strictEqual(serviceDir, "sdk/contosowidgetmanager/widget");
+  });
+
+  it("Get default service-dir", async function () {
+    const data = await readFile("./test/examples/tspconfig-custom-service-dir.yaml", "utf8");
+    const configYaml = parseYaml(data);
+    const serviceDir = getServiceDir(configYaml, "@azure-tools/typespec-python");
+    assert.strictEqual(serviceDir, "sdk/contosowidgetmanager");
+  });
+});