Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Incompatible with the vscode docs and environment #559

Open
crcdng opened this issue Jun 22, 2024 · 1 comment
Open

Incompatible with the vscode docs and environment #559

crcdng opened this issue Jun 22, 2024 · 1 comment
Assignees
Labels
bug Something isn't working

Comments

@crcdng
Copy link

crcdng commented Jun 22, 2024

The instructions in the Getting Started Guide are incompatible with the vscode environment and with the documentation.

The official guides to build a webview extension and to use a bundler are:

https://github.com/microsoft/vscode-webview-ui-toolkit/blob/main/docs/getting-started.md,
https://code.visualstudio.com/api/extension-guides/webview
and
https://code.visualstudio.com/api/working-with-extensions/bundling-extension

As mentioned in #556, the guide is too long and contradicts the instructions in https://code.visualstudio.com/api/extension-guides/webview and in https://code.visualstudio.com/api/working-with-extensions/bundling-extension

As mentioned in #546, the required esbuild version (16.x) is not supported by the vscode extension environment anymore and leads to build errors.

To reproduce

Follow the instructions to create an extension, then build a webview extension and add esbuild.

Now attempt to add the toolkit following the Getting Started Guide.

Expected behavior

The Getting Started Guide should

  • document the toolkit only (not explain how to create a vscode extension from scratch) and
  • build on / refer to the existing vscode documentation instead.

This minimizes the possibility that both documentations go out of sync.

The toolkit itself should be in sync with the current vscode extension dependencies. Concretely this means supporting esbuild >= 0.17.x but in general this should be a test case.

@crcdng crcdng added the bug Something isn't working label Jun 22, 2024
@FALLAI-Denis
Copy link

Hi,

The Getting Started Guide cannot be applied with a recent installation of generator-code... various errors appear during the setup of the example.
In particular in relation to:

But not only... also src/webview/main.ts must be a module...

Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants