Files
vscode/src/vscode-dts
Megan RoggeandDaniel Imms 3e9bfdddc0 quick fix API polish (#168688)
* fix #167649

* Update src/vs/platform/terminal/common/xterm/terminalQuickFix.ts

* fix #167652

* add builtin everywhere for consistency

* fix  #167621 and fix #167646

* get rid of type in api

* fix  #167584

* fix #167587

* fix #167587

* fix #167590 and fix #167557

* Revert "fix #167652"

This reverts commit cf4cc72790.

* Update src/vs/workbench/contrib/terminal/common/terminal.ts

Co-authored-by: Daniel Imms <2193314+Tyriar@users.noreply.github.com>

* Update src/vscode-dts/vscode.proposed.terminalQuickFixProvider.d.ts

Co-authored-by: Daniel Imms <2193314+Tyriar@users.noreply.github.com>

* use const enum + more

* use classes

* update npm package.json

* add example for outputMatcher

* improve description

Co-authored-by: Daniel Imms <2193314+Tyriar@users.noreply.github.com>
2022-12-13 19:32:54 +01:00
..

vscode-dts

This is the place for the stable API and for API proposals.

Consume a proposal

  1. find a proposal you are interested in
  2. add its name to your extensions package.json#enabledApiProposals property
  3. run npx vscode-dts dev to download the d.ts files into your project
  4. don't forget that extension using proposed API cannot be published
  5. learn more here: https://code.visualstudio.com/api/advanced-topics/using-proposed-api

Add a new proposal

  1. create a new file in this directory, its name must follow this pattern vscode.proposed.[a-zA-Z]+.d.ts
  2. creating the proposal-file will automatically update src/vs/workbench/services/extensions/common/extensionsApiProposals.ts (make sure to run yarn watch)
  3. declare and implement your proposal
  4. make sure to use the checkProposedApiEnabled and/or isProposedApiEnabled-utils to enforce the API being proposed. Make sure to invoke them with your proposal's name which got generated into extensionsApiProposals.ts
  5. Most likely will need to add your proposed api to vscode-api-tests as well