Support completion for tspconfig.yaml file in vscode

.chronus/changes/tspconfig-auto-complete-2024-9-18-13-48-34.md

@@ -0,0 +1,8 @@
+---
+changeKind: feature
+packages:
+  - "@typespec/compiler"
+  - typespec-vscode
+---
+
+Support completion for tspconfig.yaml file in vscode

.chronus/changes/tspconfig-auto-complete-2024-9-18-15-55-42.md

@@ -0,0 +1,7 @@
+---
+changeKind: fix
+packages:
+  - "@typespec/internal-build-utils"
+---
+
+Fix bug: skip package.json whose name is undefined

.vscode/launch.json

@@ -93,6 +93,16 @@
         "order": 2
       }
     },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Generate-third-party-notices for vscode extension",
+      "program": "${workspaceFolder}/packages/internal-build-utils/dist/src/cli.js",
+      "args": ["generate-third-party-notices"],
+      "sourceMaps": true,
+      "skipFiles": ["<node_internals>/**/*.js"],
+      "cwd": "${workspaceFolder}/packages/typespec-vscode"
+    },
     {
       "name": "Regenerate .tmlanguage",
       "type": "node",

packages/compiler/src/config/config-schema.ts

@@ -79,6 +79,7 @@ export const TypeSpecConfigJsonSchema: JSONSchemaType<TypeSpecRawConfig> = {
     emitters: {
       type: "object",
       nullable: true,
+      deprecated: true,
       required: [],
       additionalProperties: {
         oneOf: [{ type: "boolean" }, emitterOptionsSchema],

packages/compiler/src/server/server.ts

@@ -15,7 +15,7 @@ import {
 import { NodeHost } from "../core/node-host.js";
 import { typespecVersion } from "../utils/misc.js";
 import { createServer } from "./serverlib.js";
-import { Server, ServerHost, ServerLog } from "./types.js";
+import { Server, ServerHost, ServerLog, ServerOnRequestMethodName } from "./types.js";
 
 let server: Server | undefined = undefined;
 
@@ -129,6 +129,10 @@ function main() {
   connection.onExecuteCommand(profile(s.executeCommand));
   connection.languages.semanticTokens.on(profile(s.buildSemanticTokens));
 
+  const getTypespecConfigJsonSchemaMethodName: ServerOnRequestMethodName =
+    "typespec/getTypeSpecConfigJsonSchema";
+  connection.onRequest(getTypespecConfigJsonSchemaMethodName, s.getTypeSpecConfigJsonSchema);
+
   documents.onDidChangeContent(profile(s.checkChange));
   documents.onDidClose(profile(s.documentClosed));
 

packages/compiler/src/server/serverlib.ts

@@ -45,6 +45,8 @@ import {
   WorkspaceEdit,
   WorkspaceFoldersChangeEvent,
 } from "vscode-languageserver/node.js";
+import { TypeSpecConfigJsonSchema } from "../config/config-schema.js";
+import { TypeSpecRawConfig } from "../config/types.js";
 import { CharCode } from "../core/charcode.js";
 import { resolveCodeFix } from "../core/code-fixes.js";
 import { compilerAssert, getSourceLocation } from "../core/diagnostics.js";
@@ -66,6 +68,7 @@ import {
   Diagnostic,
   DiagnosticTarget,
   IdentifierNode,
+  JSONSchemaType,
   Node,
   PositionDetail,
   SourceFile,
@@ -155,6 +158,7 @@ export function createServer(host: ServerHost): Server {
     getCodeActions,
     executeCommand,
     log,
+    getTypeSpecConfigJsonSchema,
   };
 
   async function initialize(params: InitializeParams): Promise<InitializeResult> {
@@ -247,6 +251,10 @@ export function createServer(host: ServerHost): Server {
     log({ level: "info", message: "Initialization complete." });
   }
 
+  async function getTypeSpecConfigJsonSchema(): Promise<JSONSchemaType<TypeSpecRawConfig>> {
+    return TypeSpecConfigJsonSchema;
+  }
+
   async function workspaceFoldersChanged(e: WorkspaceFoldersChangeEvent) {
     log({ level: "info", message: "Workspace Folders Changed", detail: e });
     const map = new Map(workspaceFolders.map((f) => [f.uri, f]));

packages/compiler/src/server/types.ts

@@ -37,7 +37,14 @@ import {
   WorkspaceFoldersChangeEvent,
 } from "vscode-languageserver";
 import { TextDocument, TextEdit } from "vscode-languageserver-textdocument";
-import type { CompilerHost, Program, SourceFile, TypeSpecScriptNode } from "../core/index.js";
+import { TypeSpecRawConfig } from "../config/types.js";
+import type {
+  CompilerHost,
+  JSONSchemaType,
+  Program,
+  SourceFile,
+  TypeSpecScriptNode,
+} from "../core/index.js";
 
 export type ServerLogLevel = "trace" | "debug" | "info" | "warning" | "error";
 export interface ServerLog {
@@ -89,8 +96,12 @@ export interface Server {
   getCodeActions(params: CodeActionParams): Promise<CodeAction[]>;
   executeCommand(params: ExecuteCommandParams): Promise<void>;
   log(log: ServerLog): void;
+  // following methods are going through onRequest interface of LSP
+  getTypeSpecConfigJsonSchema(): Promise<JSONSchemaType<TypeSpecRawConfig>>;
 }
 
+export type ServerOnRequestMethodName = "typespec/getTypeSpecConfigJsonSchema";
+
 export interface ServerSourceFile extends SourceFile {
   // Keep track of the open document (if any) associated with a source file.
   readonly document?: TextDocument;

packages/internal-build-utils/src/generate-third-party-notice.ts

@@ -98,6 +98,10 @@ async function getPackageRoot(filename: string): Promise<string | undefined> {
   try {
     const pkgPath = join(dir, "package.json");
     await stat(pkgPath);
+    const pkg = JSON.parse(await readFile(pkgPath, "utf-8"));
+    if (!pkg.name) {
+      return getPackageRoot(dir);
+    }
     return dir;
   } catch (e: any) {
     if (e.code === "ENOENT") {

packages/typespec-vscode/ThirdPartyNotices.txt

@@ -12,6 +12,7 @@ granted herein, whether by implication, estoppel or otherwise.
 2. brace-expansion version 2.0.1 (https://github.com/juliangruber/brace-expansion)
 3. minimatch version 5.1.6 (https://github.com/isaacs/minimatch)
 4. semver version 7.6.3 (https://github.com/npm/node-semver)
+5. yaml version 2.5.1 (github:eemeli/yaml)
 
 
 %% balanced-match NOTICES AND INFORMATION BEGIN HERE
@@ -111,4 +112,24 @@ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
 IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
 =====================================================");
-END OF semver NOTICES AND INFORMATION
+END OF semver NOTICES AND INFORMATION
+
+
+%% yaml NOTICES AND INFORMATION BEGIN HERE
+=====================================================
+Copyright Eemeli Aro <eemeli@gmail.com>
+
+Permission to use, copy, modify, and/or distribute this software for any purpose
+with or without fee is hereby granted, provided that the above copyright notice
+and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
+OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
+THIS SOFTWARE.
+
+=====================================================");
+END OF yaml NOTICES AND INFORMATION

packages/typespec-vscode/package.json

@@ -30,7 +30,8 @@
   },
   "activationEvents": [
     "onLanguage:typespec",
-    "onCommand:typespec.restartServer"
+    "onCommand:typespec.restartServer",
+    "workspaceContains:**/tspconfig.yaml"
   ],
   "icon": "./icons/logo.png",
   "contributes": {
@@ -155,8 +156,10 @@
     "package-vsix": "vsce package",
     "deploy": "vsce publish",
     "open-in-browser": "vscode-test-web --extensionDevelopmentPath=. .",
+    "test": "vitest run",
+    "test:watch": "vitest -w",
     "test:e2e": "pnpm test:web",
-    "test:web": "vscode-test-web --extensionDevelopmentPath=. --headless --extensionTestsPath=dist/test/suite.js ./test/data"
+    "test:web": "vscode-test-web --extensionDevelopmentPath=. --headless --extensionTestsPath=dist/test/web/suite.js ./test/web/data"
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "~28.0.0",
@@ -177,6 +180,7 @@
     "rollup": "~4.24.0",
     "typescript": "~5.6.3",
     "vitest": "^2.1.2",
-    "vscode-languageclient": "~9.0.1"
+    "vscode-languageclient": "~9.0.1",
+    "vscode-languageserver-textdocument": "~1.0.12"
   }
 }

packages/typespec-vscode/rollup.config.ts

@@ -1,8 +1,13 @@
 import commonjs from "@rollup/plugin-commonjs";
 import resolve from "@rollup/plugin-node-resolve";
 import typescript from "@rollup/plugin-typescript";
+import path from "path";
 
 import { defineConfig } from "rollup";
+import { fileURLToPath } from "url";
+
+const curFile = fileURLToPath(import.meta.url);
+const curDir = path.dirname(curFile);
 
 const plugins = [(resolve as any)({ preferBuiltins: true }), (commonjs as any)()];
 const baseConfig = defineConfig({
@@ -53,17 +58,24 @@ export default defineConfig([
   },
   {
     ...baseConfig,
-    input: "test/suite.ts",
+    input: "test/web/suite.ts",
     output: {
-      file: "dist/test/suite.js", // VSCode web will add extra .js if you use .cjs
+      file: "dist/test/web/suite.js", // VSCode web will add extra .js if you use .cjs
       format: "commonjs",
       sourcemap: true,
       inlineDynamicImports: true,
     },
-    plugins: [...plugins, ts("dist/test")],
+    plugins: [...plugins, ts("dist/test/web")],
   },
 ]);
 
 function ts(outDir: string) {
-  return (typescript as any)({ tsconfig: "./tsconfig.build.json", outDir });
+  return (typescript as any)({
+    compilerOptions: {
+      // set sourceRoot to absolute path, otherwise the path in the map file generated is incorrect when outDir is given
+      sourceRoot: curDir,
+    },
+    tsconfig: "./tsconfig.build.json",
+    outDir,
+  });
 }