VS Code Extension Samples

This repository contains sample code illustrating the VS Code extension API. Each sample is a self-contained extension that explains one topic in VS Code API or VS Code's Contribution Points. You can read, play with or adapt from these samples to create your own extensions.

You can expect from each sample:

• An explanation of its functionality
• A gif or screenshot demonstrating its usage
• Link to a guide on VS Code website, if it has one
• Listing of used VS Code API and Contribution Points
• Code of the same style, enforced using TSLint

Usage

• git clone https://github.com/Microsoft/vscode-extension-samples
• code <any-sample-folder>
• npm install in the terminal, then F5 to run the sample
• Alternatively, follow the instructions in each sample's README for setting up and running the sample

Getting Started

• Hello Code Sample: The Hello World sample for VS Code.
• Hello Code Minimal Sample: A minimal version of Hello Code Sample that doesn't use TypeScript.

Samples

🚧 Some links point to our work-in-progress API Extension documentation that is not yet published 🚧

Sample	Guide on VS Code Website	API & Contribution
Multi Root Sample	N/A	workspace.getWorkspaceFolder workspace.onDidChangeWorkspaceFolders
Webview Sample	/api/extension-guides/webview	window.createWebviewPanel window.registerWebviewPanelSerializer
Status Bar	/api/extension-guides/status-bar	StatusBarItem
Completion Provider Sample	N/A	languages.registerCompletionItemProvider CompletionItem SnippetString
File System Provider Sample	N/A	workspace.registerFileSystemProvider
Editor Decoractor Sample	N/A	TextEditor.setDecorations DecorationOptions DecorationInstanceRenderOptions ThemableDecorationInstanceRenderOptions window.createTextEditorDecorationType TextEditorDecorationType contributes.colors
I18n Sample	N/A
Task Provider Sample	/api/extension-guides/task-provider	tasks.registerTaskProvider Task ShellExecution contributes.taskDefinitions
Terminal Sample	N/A	window.createTerminal window.onDidChangeActiveTerminal window.onDidCloseTerminal window.onDidOpenTerminal window.Terminal window.terminals
Tree View Sample	/api/extension-guides/tree-view	window.createTreeView window.registerTreeDataProvider TreeView TreeDataProvider contributes.views contributes.viewsContainers
Vim Sample	N/A	commands StatusBarItem window.createStatusBarItem TextEditorCursorStyle window.activeTextEditor Position Range Selection TextEditor TextEditorRevealType TextDocument

Language Protocol Server Samples

Sample	Guide on VS Code Website	API & Contribution
LSP Sample	/api/language-extensions/smart-editing-lsp-guide
LSP Log Streaming Sample	N/A
LSP Multi Root Server Sample	https://github.com/Microsoft/vscode/wiki/Extension-Authoring:-Adopting-Multi-Root-Workspace-APIs#language-client--language-server
Language Configuration Sample	/api/language-extensions/language-configuration-guide	contributes.languages
Snippet Sample	/api/language-extensions/snippet-guide	contributes.snippets

⚠️ Legacy Samples ⚠️

Legacy samples are at /legacy-samples. They are unlikely to receive any updates and might not work with the latest version of VS Code.

Sample	Deprecated Reason
Preview HTML	Webview API supersedes the old HTML Preview functionality

License

Copyright (c) Microsoft Corporation. All rights reserved.

Licensed under the MIT License.