fix(vscode-extension): improve console output when tsp-server not fou…

…nd (#5428) - print more messages when resolving tsp-server executable - improve configuration setting description fix #5080 --------- Co-authored-by: Mingzhe Huang (from Dev Box) <[email protected]>
microsoft · Jan 10, 2025 · 5e26257 · 5e26257
1 parent b221ef7
commit 5e26257
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 4 deletions.
diff --git a/...s/changes/typespec-vscode-fix-tsp-server-resolution-error-2024-11-23-14-5-54.md b/...s/changes/typespec-vscode-fix-tsp-server-resolution-error-2024-11-23-14-5-54.md
@@ -0,0 +1,7 @@
+---
+changeKind: fix
+packages:
+  - typespec-vscode
+---
+
+improve console output when tsp-server not found
diff --git a/packages/typespec-vscode/package.json b/packages/typespec-vscode/package.json
@@ -71,7 +71,7 @@
           "typespec.tsp-server.path": {
             "type": "string",
             "default": "",
-            "description": "Path to `tsp-server` command that runs the TypeSpec language server.\n\nIf not specified, then `tsp-server` found on PATH is used.\n\nExample (User): /usr/local/bin/tsp-server\nExample (Workspace): ${workspaceFolder}/node_modules/@typespec/compiler",
+            "description": "Path to 'tsp-server' command that runs the TypeSpec language server. If not specified, then 'tsp-server' will be resolved in following sequence:\n\n1. from workspace node_modules folder\nExample: ${workspaceFolder}/node_modules/@typespec/compiler\n\n2. from PATH environment variable\nExample: /usr/local/bin/tsp-server",
             "scope": "machine-overridable"
           },
           "typespec.initTemplatesUrls": {

diff --git a/packages/typespec-vscode/src/tsp-executable-resolver.ts b/packages/typespec-vscode/src/tsp-executable-resolver.ts
@@ -63,7 +63,7 @@ export async function resolveTypeSpecServer(context: ExtensionContext): Promise<
     options.env.NODE_OPTIONS = nodeOptions;
   }
 
-  // In production, first try VS Code configuration, which allows a global machine
+  // In production, first try VS Code extension configuration, which allows a global machine
   // location that is not on PATH, or a workspace-specific installation.
   let serverPath: string | undefined = workspace.getConfiguration().get(SettingName.TspServerPath);
   if (serverPath && typeof serverPath !== "string") {
@@ -74,13 +74,19 @@ export async function resolveTypeSpecServer(context: ExtensionContext): Promise<
   // Default to tsp-server on PATH, which would come from `npm install -g
   // @typespec/compiler` in a vanilla setup.
   if (serverPath) {
-    logger.debug(`Server path loaded from VS Code configuration: ${serverPath}`);
+    logger.info(`Server path loaded from TypeSpec extension configuration: ${serverPath}`);
   } else {
+    logger.info(
+      "Server path not configured in TypeSpec extension configuration, trying to resolve locally within current workspace.",
+    );
     serverPath = await resolveLocalCompiler(workspaceFolder);
   }
+
   if (!serverPath) {
     const executable = process.platform === "win32" ? "tsp-server.cmd" : "tsp-server";
-    logger.debug(`Can't resolve server path, try to use default value ${executable}.`);
+    logger.warning(
+      `Can't resolve server path from either TypeSpec extension configuration or workspace, try to use default value ${executable}.`,
+    );
     return useShellInExec({ command: executable, args, options });
   }
   const variableResolver = new VSCodeVariableResolver({