Support completion for tspconfig.yaml file in vscode #4790

RodgeFu · 2024-10-18T07:14:58Z

Add support of completion for tspconfig.yaml file in vscode
Code refactor considering we are having more code/features in vscode extension
Enable unit test in vscode extension
Also fixed small bugs in restart LSP client and the tool generating license

related issues:
#2049, #2996

…lete

azure-sdk · 2024-10-18T07:17:01Z

All changed packages have been documented.

✅ @typespec/compiler
✅ @typespec/playground
✅ typespec-vscode

Show changes

`@typespec/compiler` - feature ✏️

Support completion for tspconfig.yaml file in vscode

`typespec-vscode` - feature ✏️

Support completion for tspconfig.yaml file in vscode

`@typespec/playground` - internal ✏️

Add support for typespec compiler watch

azure-sdk · 2024-10-18T08:35:33Z

You can try these changes here

🛝 Playground	🌐 Website	📚 Next docs

packages/typespec-vscode/src/vscode/completion-item-provider.ts

timotheeguerin · 2024-10-18T14:59:37Z

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) {


This feels like a weird interpretation to decide to skip unnamed package

it's because the tool would crash when the package.json found is "incomplete" because it will try to extract many information from it. I added the check/skip because I think the package should at least have a name if we are expected to get license information from it. But feel free to let me know if there are other better way to do the check.

In detail, I added the change because it crashees when I installed 'vscode-languageserver-textdocument' package which contains a package.json as below...

yeah I guess that'd be ok, though I am not sure its needed anymore as the code was moved back in the compiler

it's not needed anymore. removed.

packages/typespec-vscode/src/vscode/completion-item-provider.ts

timotheeguerin · 2024-10-23T14:46:53Z

.vscode/launch.json

@@ -93,6 +93,16 @@
        "order": 2
      }
    },
+    {


Do we need an extra launch config for this one, can we use the js debug console in vscode to auto attach for those one off things

RodgeFu · 2024-10-23T15:00:09Z

packages/playground/src/browser-host.ts

        }
      }
    },

+    watch(path: string, onChanged: (filename: string) => void) {


what kind of changelog should I add for internal change like this?

in a sense that change in the compiler is a breaking change as have to update all custom hosts.
With other comments talking about if we really even need this, then that change for this package would be something like Add support for typespec compiler watch

changelog added. thanks.

timotheeguerin · 2024-10-23T14:48:22Z

packages/compiler/src/core/types.ts

+   * @param path path to the file/dir to watch
+   * @param onChanged callback to be called when the file/dir changes
+   */
+  watch(


I don';t think we should update the CompilerHost here, will keep reviewing and understand why its needed but feels like the wrong place to be adding this.

yeah I don't really get why you need to add this, we already have watch funtionality in the lsp provided by vscode, we shouldn't also try to watch with our own system

the file watch provided by vscode lsp is not suitable because the file we want to monitor may not in the workspace opened in vscode. (for example in the azure-rest-api-specs repo, i usually just open the folder of some service, but the package.json is actually at the root of the repo.). And I dont think it's a good idea to ask vscode to monitor all the folders from root recursively by default because recursive file watching is quite resource intense which should be used to minimal as suggested by vscode. So here i would prefer to add non-recursive watch explicitly only when needed.

And I added it into the CompilerHost because I think we are trying to control all the IO related operations there so that we can change the implementations and they still work with each other. thanks.

timotheeguerin · 2024-10-23T14:49:46Z

packages/compiler/src/server/completion-tspconfig.ts

@@ -0,0 +1,213 @@
+import { TextDocument } from "vscode-languageserver-textdocument";


nit: what do youi think about organzing this into a src/server/tspconfig/ with completion.ts folder so if we add more functionality we can keep things nicely organized

sounds good to me. moved it to .../tspconfig/completion.ts

timotheeguerin · 2024-10-23T14:51:08Z

packages/compiler/src/server/emitter-provider.ts

+export class EmitterProvider {
+  constructor(private npmPackageProvider: NpmPackageProvider) {}
+
+  private static async isEmitter(pkg: NpmPackage) {


nit: private methods after public?

moved. thanks.

timotheeguerin · 2024-10-23T14:52:44Z

packages/compiler/src/server/emitter-provider.ts

+  private static async isEmitter(pkg: NpmPackage) {
+    const data = await pkg.getPackageJsonData();
+    if (!data) return false;
+    const dep = {


feels better to just have to do the if statement twice above than extra object spread

timotheeguerin · 2024-10-23T14:54:56Z

packages/typespec-vscode/src/extension.ts

Any chance we can separate the change that are not related to the tspconfig into their own pr/what needs to be reverted now that vscode extension doesn't actually have the extra features

sure, reverted those changes not related and will file another PR for them. thanks.

timotheeguerin · 2024-10-23T14:58:48Z

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) {


yeah I guess that'd be ok, though I am not sure its needed anymore as the code was moved back in the compiler

timotheeguerin · 2024-10-23T14:59:24Z

packages/typespec-vscode/vitest.config.ts

+  defineConfig({
+    test: {
+      include: ["test/unit/**/*.test.ts"],
+      disableConsoleIntercept: true,


what kind of logs do you end up with? this does make it quite hard to debug sometimes if you cannot use console.log

for some reason, my console log doesnt show up without that line. Anyway, i have moved this change to another PR and will remove this line there.

timotheeguerin · 2024-10-23T15:10:21Z

packages/compiler/src/server/completion-tspconfig.ts

+import { FileService } from "./file-service.js";
+import { resolveYamlScalarTarget, YamlScalarTarget } from "./yaml-resolver.js";
+
+type ObjectJSONSchemaType = JSONSchemaType<object>;


Listing issues/improvements with the completion when testing it, most of those could definitely be added as new issues and done later:

extends could have path completion

same for imports I think

linter doesn't complete rule or rulesets

emitter option auto complete while inside "" will add extra ""`

completion for known variables/parameters/env interpolation

but otherwise this is really nice, thanks!

Thanks. Yeah, those likes next step for this feature. Will file issue for them when this PR is in.

…lete

RodgeFu added 19 commits September 23, 2024 17:12

support load packages with cache

b09a0d4

Merge remote-tracking branch 'upstream/main' into tspconfig-auto-comp…

95b5b14

…lete

support tspconfig.yaml auto-complete

ed1c6a7

Merge remote-tracking branch 'upstream/main' into tspconfig-auto-comp…

83ae96d

…lete

some refactor

5b17b89

add unit test and some refine

d1577cd

Merge remote-tracking branch 'upstream/main' into tspconfig-auto-comp…

90e1eee

…lete

add test for tspconfig auto complete

c6b1ddc

some refine in code

a051b7a

refine code

c39038e

fix some issues

0966eda

fix mapping file

c3d898b

small refine

b8dfd5d

some more update

349d83d

update to watch folder instead of file to get add/delete event

fe026be

add changelog

7a647f8

Merge remote-tracking branch 'upstream/main' into tspconfig-auto-comp…

b013f6c

…lete

add some comment

39df8ff

update changelog

3d56196

RodgeFu requested review from bterlson, markcowl, allenjzhang and timotheeguerin as code owners October 18, 2024 07:14

RodgeFu added the ide Issues for VS, VSCode, Monaco, etc. label Oct 18, 2024

RodgeFu assigned timotheeguerin Oct 18, 2024

RodgeFu added 2 commits October 18, 2024 15:58

add changelog

3ab3733

add changelog

1856276

timotheeguerin reviewed Oct 18, 2024

View reviewed changes

packages/typespec-vscode/src/vscode/completion-item-provider.ts Outdated Show resolved Hide resolved

timotheeguerin reviewed Oct 21, 2024

View reviewed changes

RodgeFu added 5 commits October 23, 2024 18:28

move completion of tspconfig to compiler

8e885f9

some small update

a385854

merge from upstream/main

f03be39

update pnpm-lock

85accbc

update watch func in host

bbd87b3

RodgeFu requested review from iscai-msft, tadelesh, msyyc, srnagar, weidongxu-microsoft, haolingdong-msft, XiaofeiCao, m-nash and JoshLove-msft as code owners October 23, 2024 14:32

RodgeFu and others added 2 commits October 23, 2024 22:43

Merge branch 'main' into tspconfig-auto-complete

295074b

update pnpm lock

e8e4b65

timotheeguerin reviewed Oct 23, 2024

View reviewed changes

update for prettier warning

1ea469b

RodgeFu commented Oct 23, 2024

View reviewed changes

timotheeguerin reviewed Oct 23, 2024

View reviewed changes

RodgeFu added 7 commits October 23, 2024 23:12

fix watch's close impl

d47f262

update per comment

3bced9b

revert unexpected change

424a86c

add changelog for compiler watch

a49ba7c

update per prettier comment

8f7be84

Merge remote-tracking branch 'upstream/main' into tspconfig-auto-comp…

ef41b8b

…lete

remove .orig file

57c33b9

RodgeFu mentioned this pull request Oct 24, 2024

Improvements for the intellisense of tspconfig.yaml #4855

Open

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support completion for tspconfig.yaml file in vscode #4790

Support completion for tspconfig.yaml file in vscode #4790

RodgeFu commented Oct 18, 2024

azure-sdk commented Oct 18, 2024 •

edited

Loading

`@typespec/compiler` - feature ✏️

`typespec-vscode` - feature ✏️

`@typespec/playground` - internal ✏️

azure-sdk commented Oct 18, 2024

timotheeguerin Oct 18, 2024

RodgeFu Oct 22, 2024

timotheeguerin Oct 23, 2024

RodgeFu Oct 24, 2024

timotheeguerin Oct 23, 2024

RodgeFu Oct 24, 2024

RodgeFu Oct 23, 2024

timotheeguerin Oct 23, 2024

RodgeFu Oct 24, 2024

timotheeguerin Oct 23, 2024

timotheeguerin Oct 23, 2024

RodgeFu Oct 24, 2024 •

edited

Loading

timotheeguerin Oct 23, 2024

RodgeFu Oct 24, 2024

timotheeguerin Oct 23, 2024

RodgeFu Oct 24, 2024

timotheeguerin Oct 23, 2024

RodgeFu Oct 24, 2024

timotheeguerin Oct 23, 2024

RodgeFu Oct 24, 2024

timotheeguerin Oct 23, 2024

timotheeguerin Oct 23, 2024

RodgeFu Oct 24, 2024

timotheeguerin Oct 23, 2024

timotheeguerin Oct 23, 2024

RodgeFu Oct 24, 2024

		@@ -0,0 +1,213 @@
		import { TextDocument } from "vscode-languageserver-textdocument";

Support completion for tspconfig.yaml file in vscode #4790

Are you sure you want to change the base?

Support completion for tspconfig.yaml file in vscode #4790

Conversation

RodgeFu commented Oct 18, 2024

azure-sdk commented Oct 18, 2024 • edited Loading

@typespec/compiler - feature ✏️

typespec-vscode - feature ✏️

@typespec/playground - internal ✏️

azure-sdk commented Oct 18, 2024

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 Oct 24, 2024 • edited Loading

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

Choose a reason for hiding this comment

azure-sdk commented Oct 18, 2024 •

edited

Loading

`@typespec/compiler` - feature ✏️

`typespec-vscode` - feature ✏️

`@typespec/playground` - internal ✏️

RodgeFu Oct 24, 2024 •

edited

Loading