microsoft/vscode
1
0
Fork 0
mirror of https://github.com/microsoft/vscode.git synced 2025-12-10 14:16:15 -06:00
Code Issues Packages Projects Releases 177 Wiki Activity

Updated Extension API process (markdown)

Johannes Rieken 2018-09-07 15:41:36 +02:00
parent d10537df11
commit 5e135988e9
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Extension-API-process.md

@ -8,7 +8,7 @@ About Proposed API
We work with API proposals on which we iterate a few times before making stable API. Those proposals can be tested by extension authors. The proposed API is defined in [`vscode.proposed.d.ts`](https://github.com/Microsoft/vscode/blob/master/src/vs/vscode.proposed.d.ts). This is what you have to do to try out a proposed API:
* You must use [Insiders](https://code.visualstudio.com/insiders/) because proposed APIs change frequently.
* You must have this line in the package.json file of your extension: `"enableProposedAPI": true.`
* You must have this line in the package.json file of your extension: `"enableProposedApi": true.`
* Copy the latest version of the [`vscode.proposed.d.ts`](https://github.com/Microsoft/vscode/blob/master/src/vs/vscode.proposed.d.ts)-file into your project.
Note that you cannot publish an extension that uses a proposed API. We may likely make breaking changes in the next release and we never want to break existing extensions.