Skip to content

Files

Latest commit

 

History

History
 
 

proposed-api-sample

Proposed API Sample

This sample demonstrates usage of Proposed API.

The postinstall script uses vscode-dts dev && vscode-dts main to download latest version of vscode.d.ts and vscode.proposed.<proposalName>.d.ts from the main branch of microsoft/vscode.

You can read more about vscode-dts at: https://github.com/microsoft/vscode-dts.

  • ⚠️ This sample can only be used for extension development in Insider release. You cannot publish extensions using Proposed API.
  • You need "enabledApiProposals": ["<proposalName>"] in package.json.

VS Code API

vscode module

Contribution Points

Running the Sample

  • Run npm install in terminal to install dependencies
  • A postinstall script would download latest version of vscode.proposed.<proposalName>.d.ts
  • Run the Run Extension target in the Debug View. This will:
    • Start a task npm: watch to compile the code
    • Run the extension in a new VS Code window