question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Web: provide a `workbench.web.api.d.ts` for an embedder to develop against

See original GitHub issue

We provide an API surface for an embedder of our web UI:

https://github.com/microsoft/vscode/blob/7a83e5aa6278d27120c26dabe2b59642dcad9cf2/src/vs/workbench/workbench.web.api.ts#L238-L238

We also require some specific setup to load our web UI pieces as indicated by our yarn web implementation:

https://github.com/microsoft/vscode/blob/c87c95a1a04b01107328fe1987b1865b2eb367a8/src/vs/code/browser/workbench/workbench.html#L42-L42

We should:

  • investigate to produce a workbench.web.api.d.ts (similar to monaco.d.ts) for the workbench.web.api for an embedder to develop against
  • consider to extract the loader configuration into something reusable (amdconfig.js?) that an embedder can just point to

Issue Analytics

  • State:open
  • Created 2 years ago
  • Comments:8 (8 by maintainers)

github_iconTop GitHub Comments

1reaction
bpaserocommented, Nov 9, 2022

@joaomoreno pointed out this tool which maybe could help: https://api-extractor.com/

Naive first run and error: https://github.com/microsoft/rushstack/issues/3738

0reactions
jriekencommented, Apr 13, 2022

Yeah, we explicitly implement the API in src/vs/workbench/api/common/extHost.api.impl.ts, we define a type which is of the vscode-module here: https://github.com/microsoft/vscode/blob/527d63162ad6b43a5e106e93ed05c3a299bda947/src/vs/workbench/api/common/extHost.api.impl.ts#L1138

Read more comments on GitHub >

github_iconTop Results From Across the Web

provide a `workbench.web.api.d.ts` for an embedder to develop ...
Web : provide a `workbench.web.api.d.ts` for an embedder to develop against · Summary · Jobs. main · Run details. Usage · Workflow file....
Read more >
Using Proposed API - Visual Studio Code
Using a proposed API ... These are the steps for testing a proposed API in local extension development: ... The vscode-dts CLI utility...
Read more >
Build your first SharePoint client-side web part (Hello World ...
Create a new web part project. Create a new project directory for your project and change your current folder to that directory.
Read more >
Developers - Sandbox - TypeScript
This library builds on top of the Monaco Editor, providing a higher level API but ... Because we need it for the TypeScript...
Read more >
Using TypeScript with the MySQL Database - InfoQ
A recent JavaScript and Web Development InfoQ Trends Report notes that ... The complete Catalog.ts script is available on the GitHub.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found