Generate Code from TypeSpec in VSCode #5312

chunyu3 · 2024-12-10T01:48:27Z

Fix #5025

Integrate Code Generation in VSCode extension

…erateSDK

azure-sdk · 2024-12-10T01:52:36Z

All changed packages have been documented.

✅ typespec-vscode

Show changes

`typespec-vscode` - feature ✏️

integrate client SDK generation

packages/typespec-vscode/src/emit/emit.ts

timotheeguerin · 2024-12-19T12:24:17Z

.chronus/changes/generateSDK-2024-11-10-10-45-35.md

Can this wait until I'm back before merging so we can discuss a little more what we want. I do not think this is a good feature to add in this form. The argument for not requiring to learn commands to generate is I feel invalid as you still need to know the language and install anything to get the rest working.

If this instead was just providing a way to add some known emitters and configure them to the tspconfig I think this would be much much better.

Thanks @timotheeguerin .
Emitters will be registered in the VSCode extension settings. We pre-defined default emtters (both client emitters, server emitters for all languages, and the schema emitter also). We will provide a way for customer to register their customized emitter in future.

We will hold this PR merge and we discuss more after you back. Thanks

@timotheeguerin , thanks for looking at the PR in holiday and Merry Christmas!
Below is the spec for the feature (Those user cases with name "Generate XXX from TypeSpec") which should be able to give you more context and the user experience we want to provide. Any feedback is welcome, and we can discuss more when you are back. thanks.
https://microsoft.sharepoint.com/:w:/t/AzureDeveloperExperience/EXfInUWxaOpNpXVtcQOAt4cBoVwvu3tZe3Od__r9vdc8qQ?e=cmyNb0

packages/typespec-vscode/src/const.ts

packages/typespec-vscode/src/emit/emit-quick-pick-item.ts

…erateSDK

RodgeFu · 2024-12-23T12:51:32Z

packages/typespec-vscode/src/emit/emit.ts

+  PreDefinedEmitterPickItems,
+} from "./emitter.js";
+
+export async function doEmit(


seems no need to export

RodgeFu · 2024-12-23T12:54:07Z

packages/typespec-vscode/src/emit/emit.ts

+  if (!selectedEmitter) {
+    logger.info("No emitter selected. Generating Cancelled.", [], {
+      showOutput: false,
+      showPopup: false,


false is the default value, you can just logger.info("...") to make your code shorter.

RodgeFu · 2024-12-23T13:03:33Z

packages/typespec-vscode/src/emit/emit.ts

+    return;
+  }
+
+  logger.info("npm install...", [], {


npm install? People (us or end users) will use the log to do troubleshooting, please help to make these logs more detail and understandable.

RodgeFu · 2024-12-23T13:08:59Z

packages/typespec-vscode/src/emit/emit.ts

+    logger.info(`${dependenciesToInstall}`);
+    if (dependenciesToInstall.length > 0) {
+      vscode.window.showInformationMessage(
+        `Need to manually upgrade following dependency packages: ${dependenciesToInstall.join("\\n")}. \nGenerating Cancelled`,


no option to install them for user?

RodgeFu · 2024-12-23T13:11:36Z

packages/typespec-vscode/src/emit/emit.ts

+    );
+    return;
+  }
+  const outputDir = path.resolve(baseDir, selectedEmitter.emitterKind, selectedEmitter.language);


path.resolve? shouldn't be joinPath?

RodgeFu · 2024-12-23T13:15:05Z

packages/typespec-vscode/src/emit/emit.ts

+  });
+
+  const emitterKinds = getRegisterEmitterTypes();
+  const toEitTypeQuickPickItem = (kind: EmitterKind): any => {


RodgeFu · 2024-12-23T13:19:56Z

packages/typespec-vscode/src/npm-utils.ts

+  devDependencies = "devDependencies",
+}
+
+export interface NpmPackageInfo {


there is a NodePackage type in compiler you can use directly

RodgeFu · 2024-12-23T13:26:40Z

packages/typespec-vscode/src/npm-utils.ts

+import logger from "./log/logger.js";
+import { ExecOutput, loadModule, spawnExecution, spawnExecutionEvents } from "./utils.js";
+
+export enum InstallationAction {


usually we prefer to use union to enum. like: InstallationAction = "install" | "upgrade" | "skip" | "cancel". same for below

RodgeFu · 2024-12-23T13:28:16Z

packages/typespec-vscode/src/npm-utils.ts

+
+      if (dependenciesResult.exitCode === 0) {
+        // Remove all newline characters
+        let dependenciesJsonStr = dependenciesResult.stdout.trim();


i remember there is a --json arg, doesn't it help?

RodgeFu · 2024-12-23T13:35:36Z

packages/typespec-vscode/src/typespec-utils.ts

+    .split("\n")
+    .forEach((line) => logger.info(line));
+};
+export const onStdioError = (str: string) => {


People can't figure out what these two methods for just by name which looks more like an event name... Why not just use the spawnExecutionAndLogToOutput which would log the stdio/stderr which is just what you want to do here, isn't it?

RodgeFu · 2024-12-23T13:41:33Z

packages/typespec-vscode/src/typespec-utils.ts

+    );
+};
+
+export async function getEntrypointTspFile(tspPath: string): Promise<string | undefined> {


i think you need to search parent folder for the main.tsp too. you can refer to getMainFileForDocument in core\server\compiler-service.ts

RodgeFu · 2024-12-23T13:42:18Z

packages/typespec-vscode/src/typespec-utils.ts

+  try {
+    const files = await readdir(baseDir);
+    if (files && files.length === 1 && files[0].endsWith(".tsp")) {
+      return path.resolve(baseDir, files[0]);


it's better to report error than pick a random file which wouldn't right in most case

RodgeFu · 2024-12-23T13:43:55Z

packages/typespec-vscode/src/emit/emit.ts

+  await doEmit(context, tspProjectFile, codeType.emitterKind);
+}
+
+export async function compile(


you dont need to export this

RodgeFu · 2024-12-23T13:54:00Z

packages/typespec-vscode/src/emit/emit-quick-pick-item.ts

+import vscode from "vscode";
+import { EmitterKind } from "./emitter.js";
+
+export interface EmitQuickPickItem extends vscode.QuickPickItem {


feels you dont need to define this type explicitly either.

chunyu3 added 17 commits November 18, 2024 17:16

emit sdk

ca3249a

add emitter configuration in extension setting

b8468b6

add output dir configuration and options configuration

f0c4b89

remove unused code

4691431

update emitter configuration

539bee9

resolve tsp command

7779481

define promised exec

05bbef7

remove doEmit to emit.ts

41a8796

change to single language generation each run

31ee9e2

select language box

6d604d8

remove unused code

406e7f9

Merge branch 'main' of https://github.com/microsoft/typespec into gen…

a143f0a

…erateSDK

add validation of typespec project selection input box

a93c8b8

transfer logs from spawn

4ba9a3a

transport log out when execute command

ca87267

validate the typespec project

a14b47e

remove executeCommand

5534466

chunyu3 requested review from RodgeFu, bterlson, markcowl, allenjzhang and timotheeguerin as code owners December 10, 2024 01:48

chunyu3 marked this pull request as draft December 10, 2024 01:48

microsoft-github-policy-service bot added the ide Issues for VS, VSCode, Monaco, etc. label Dec 10, 2024

Merge branch 'main' of https://github.com/microsoft/typespec into gen…

92790d6

…erateSDK

update pnpm-lock

3a9886c

chunyu3 force-pushed the generateSDK branch from 39789e2 to 3a9886c Compare December 10, 2024 02:41

chunyu3 added 2 commits December 10, 2024 10:46

add change log

7fec5be

resolve lint

bddc07b

RodgeFu reviewed Dec 19, 2024

View reviewed changes

packages/typespec-vscode/src/emit/emit.ts Outdated Show resolved Hide resolved

chunyu3 force-pushed the generateSDK branch 4 times, most recently from 2f0fc43 to b592194 Compare December 19, 2024 09:20

timotheeguerin requested changes Dec 19, 2024

View reviewed changes

chunyu3 force-pushed the generateSDK branch 3 times, most recently from 6a30951 to 1722c43 Compare December 20, 2024 03:11

RodgeFu reviewed Dec 20, 2024

View reviewed changes

packages/typespec-vscode/src/const.ts Outdated Show resolved Hide resolved

RodgeFu reviewed Dec 20, 2024

View reviewed changes

packages/typespec-vscode/src/emit/emit-quick-pick-item.ts Outdated Show resolved Hide resolved

chunyu3 force-pushed the generateSDK branch 2 times, most recently from b2e150b to d1b7723 Compare December 20, 2024 09:19

resolve comments

f70e9d0

chunyu3 force-pushed the generateSDK branch from d1b7723 to f70e9d0 Compare December 20, 2024 09:44

Merge branch 'main' of https://github.com/microsoft/typespec into gen…

e836b52

…erateSDK

RodgeFu reviewed Dec 23, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Generate Code from TypeSpec in VSCode #5312

Generate Code from TypeSpec in VSCode #5312

chunyu3 commented Dec 10, 2024 •

edited

Loading

azure-sdk commented Dec 10, 2024 •

edited

Loading

`typespec-vscode` - feature ✏️

timotheeguerin Dec 19, 2024

chunyu3 Dec 20, 2024

RodgeFu Dec 20, 2024

RodgeFu Dec 23, 2024

RodgeFu Dec 23, 2024

RodgeFu Dec 23, 2024

RodgeFu Dec 23, 2024

RodgeFu Dec 23, 2024

RodgeFu Dec 23, 2024

RodgeFu Dec 23, 2024

RodgeFu Dec 23, 2024

RodgeFu Dec 23, 2024

RodgeFu Dec 23, 2024

RodgeFu Dec 23, 2024

RodgeFu Dec 23, 2024 •

edited

Loading

RodgeFu Dec 23, 2024

RodgeFu Dec 23, 2024

Generate Code from TypeSpec in VSCode #5312

Are you sure you want to change the base?

Generate Code from TypeSpec in VSCode #5312

Conversation

chunyu3 commented Dec 10, 2024 • edited Loading

azure-sdk commented Dec 10, 2024 • edited Loading

typespec-vscode - feature ✏️

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RodgeFu Dec 23, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chunyu3 commented Dec 10, 2024 •

edited

Loading

azure-sdk commented Dec 10, 2024 •

edited

Loading

`typespec-vscode` - feature ✏️

RodgeFu Dec 23, 2024 •

edited

Loading