mirror of
https://github.com/microsoft/vscode.git
synced 2026-04-20 00:28:52 +01:00
e7cfb10cb8
* vscode-dts: Add LineCommentConfig interface & update lineComment * rename config to rule --------- Co-authored-by: Aiday Marlen Kyzy <aidaymarlenkyzy@gmail.com>
vscode-dts
This is the place for the stable API and for API proposals.
Consume a proposal
- find a proposal you are interested in
- add its name to your extensions
package.json#enabledApiProposalsproperty - run
npx vscode-dts devto download thed.tsfiles into your project - don't forget that extension using proposed API cannot be published
- learn more here: https://code.visualstudio.com/api/advanced-topics/using-proposed-api
Add a new proposal
- create a new file in this directory, its name must follow this pattern
vscode.proposed.[a-zA-Z]+.d.ts - creating the proposal-file will automatically update
src/vs/platform/extensions/common/extensionsApiProposals.ts(make sure to runnpm run watch) - declare and implement your proposal
- make sure to use the
checkProposedApiEnabledand/orisProposedApiEnabled-utils to enforce the API being proposed. Make sure to invoke them with your proposal's name which got generated intoextensionsApiProposals.ts - Most likely will need to add your proposed api to vscode-api-tests as well