2018-05-31 08:38:41 +05:00
< h1 align = "center" >
2018-05-31 08:43:19 +05:00
VS Code Extension Samples
2018-05-31 08:38:41 +05:00
< / h1 >
2016-06-08 08:18:48 +02:00
2018-12-16 21:08:20 -08:00
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 ](https://code.visualstudio.com/api/references/vscode-api ) or VS Code's [Contribution Points ](https://code.visualstudio.com/api/references/contribution-points ). You can read, play with or adapt from these samples to create your own extensions.
2018-10-08 13:41:57 -07:00
2018-10-10 10:43:06 -07:00
You can expect from each sample:
- An explanation of its functionality
2018-10-09 12:31:56 -07:00
- 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
2020-05-29 13:12:13 -07:00
- Code of the same style, enforced using ESLint
2016-06-08 08:18:48 +02:00
2019-06-13 09:15:00 +02:00
## Prerequisites
2019-06-21 22:08:00 +01:00
You need to have [node ](https://nodejs.org/en/ ) and [npm ](https://nodejs.org/en/ ) installed on your system to run the examples. It is recommended to use the node version used for VS Code development itself which is documented [here ](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#prerequisites )
2019-06-13 09:15:00 +02:00
2018-11-05 23:02:43 -08:00
## 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
2018-10-29 17:19:37 -07:00
2019-05-28 10:01:33 +08:00
- [Hello World Sample ](helloworld-sample ): The Hello World sample for VS Code. See [Extension Anatomy ](https://code.visualstudio.com/api/get-started/extension-anatomy ) documentation.
2019-01-29 14:31:01 -08:00
- [Hello World Minimal Sample ](helloworld-minimal-sample ): A minimal version of Hello World Sample written in JavaScript.
2019-05-28 10:01:33 +08:00
- [Hello World Test Sample ](helloworld-test-sample ): Hello World sample with extension integration test. See [Testing Extensions ](https://code.visualstudio.com/api/working-with-extensions/testing-extension ) documentation.
2021-08-20 12:04:40 +02:00
- [Hello World Web Sample ](helloworld-web-sample ): The Hello World sample for VS Code Web. See the [Web Extensions ](https://code.visualstudio.com/api/extension-guides/web-extensions ) guide.
2018-10-29 17:19:37 -07:00
2018-10-09 12:31:56 -07:00
## Samples
2018-05-31 08:45:19 +05:00
2018-10-16 17:08:42 -07:00
<!-- SAMPLES_BEGIN -->
2018-10-09 12:31:56 -07:00
| Sample | Guide on VS Code Website | API & Contribution |
| ------ | ----- | --- |
2021-02-22 09:58:22 -08:00
| [Webview Sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/webview-sample ) | [/api/extension-guides/webview ](https://code.visualstudio.com/api/extension-guides/webview ) | [window.createWebviewPanel ](https://code.visualstudio.com/api/references/vscode-api#window.createWebviewPanel )< br > [window.registerWebviewPanelSerializer ](https://code.visualstudio.com/api/references/vscode-api#window.registerWebviewPanelSerializer ) |
| [Webview View Sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/webview-view-sample ) | N/A | [window.registerWebviewViewProvider ](https://code.visualstudio.com/api/references/vscode-api#window.registerWebviewViewProvider ) |
2022-06-27 17:06:11 -07:00
| [Webview Codicons Sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/webview-codicons-sample ) | N/A | |
2021-02-22 09:58:22 -08:00
| [Status Bar Sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/statusbar-sample ) | N/A | [window.createStatusBarItem ](https://code.visualstudio.com/api/references/vscode-api#window.createStatusBarItem )< br > [StatusBarItem ](https://code.visualstudio.com/api/references/vscode-api#StatusBarItem ) |
| [Tree View Sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/tree-view-sample ) | [/api/extension-guides/tree-view ](https://code.visualstudio.com/api/extension-guides/tree-view ) | [window.createTreeView ](https://code.visualstudio.com/api/references/vscode-api#window.createTreeView )< br > [window.registerTreeDataProvider ](https://code.visualstudio.com/api/references/vscode-api#window.registerTreeDataProvider )< br > [TreeView ](https://code.visualstudio.com/api/references/vscode-api#TreeView )< br > [TreeDataProvider ](https://code.visualstudio.com/api/references/vscode-api#TreeDataProvider )< br > [contributes.views ](https://code.visualstudio.com/api/references/contribution-points#contributes.views )< br > [contributes.viewsContainers ](https://code.visualstudio.com/api/references/contribution-points#contributes.viewsContainers ) |
| [Task Provider Sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/task-provider-sample ) | [/api/extension-guides/task-provider ](https://code.visualstudio.com/api/extension-guides/task-provider ) | [tasks.registerTaskProvider ](https://code.visualstudio.com/api/references/vscode-api#tasks.registerTaskProvider )< br > [Task ](https://code.visualstudio.com/api/references/vscode-api#Task )< br > [ShellExecution ](https://code.visualstudio.com/api/references/vscode-api#ShellExecution )< br > [contributes.taskDefinitions ](https://code.visualstudio.com/api/references/contribution-points#contributes.taskDefinitions ) |
| [Multi Root Sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/basic-multi-root-sample ) | N/A | [workspace.getWorkspaceFolder ](https://code.visualstudio.com/api/references/vscode-api#workspace.getWorkspaceFolder )< br > [workspace.onDidChangeWorkspaceFolders ](https://code.visualstudio.com/api/references/vscode-api#workspace.onDidChangeWorkspaceFolders ) |
| [Completion Provider Sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/completions-sample ) | N/A | [languages.registerCompletionItemProvider ](https://code.visualstudio.com/api/references/vscode-api#languages.registerCompletionItemProvider )< br > [CompletionItem ](https://code.visualstudio.com/api/references/vscode-api#CompletionItem )< br > [SnippetString ](https://code.visualstudio.com/api/references/vscode-api#SnippetString ) |
| [Code Actions Sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/code-actions-sample ) | N/A | [languages.registerCodeActionsProvider ](https://code.visualstudio.com/api/references/vscode-api#languages.registerCodeActionsProvider )< br > [CodeActionProvider ](https://code.visualstudio.com/api/references/vscode-api#CodeActionProvider ) |
| [File System Provider Sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/fsprovider-sample ) | N/A | [workspace.registerFileSystemProvider ](https://code.visualstudio.com/api/references/vscode-api#workspace.registerFileSystemProvider ) |
| [Editor Decorator Sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/decorator-sample ) | N/A | [TextEditor.setDecorations ](https://code.visualstudio.com/api/references/vscode-api#TextEditor.setDecorations )< br > [DecorationOptions ](https://code.visualstudio.com/api/references/vscode-api#DecorationOptions )< br > [DecorationInstanceRenderOptions ](https://code.visualstudio.com/api/references/vscode-api#DecorationInstanceRenderOptions )< br > [ThemableDecorationInstanceRenderOptions ](https://code.visualstudio.com/api/references/vscode-api#ThemableDecorationInstanceRenderOptions )< br > [window.createTextEditorDecorationType ](https://code.visualstudio.com/api/references/vscode-api#window.createTextEditorDecorationType )< br > [TextEditorDecorationType ](https://code.visualstudio.com/api/references/vscode-api#TextEditorDecorationType )< br > [contributes.colors ](https://code.visualstudio.com/api/references/contribution-points#contributes.colors ) |
2022-11-04 13:53:56 -07:00
| [L10n Sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/l10n-sample ) | N/A | |
2021-02-22 09:58:22 -08:00
| [Terminal Sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/terminal-sample ) | N/A | [window.createTerminal ](https://code.visualstudio.com/api/references/vscode-api#window.createTerminal )< br > [window.onDidChangeActiveTerminal ](https://code.visualstudio.com/api/references/vscode-api#window.onDidChangeActiveTerminal )< br > [window.onDidCloseTerminal ](https://code.visualstudio.com/api/references/vscode-api#window.onDidCloseTerminal )< br > [window.onDidOpenTerminal ](https://code.visualstudio.com/api/references/vscode-api#window.onDidOpenTerminal )< br > [window.Terminal ](https://code.visualstudio.com/api/references/vscode-api#window.Terminal )< br > [window.terminals ](https://code.visualstudio.com/api/references/vscode-api#window.terminals ) |
| [Extension Terminal Sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/extension-terminal-sample ) | N/A | [window.createTerminal ](https://code.visualstudio.com/api/references/vscode-api#window.createTerminal )< br > [window.Pseudoterminal ](https://code.visualstudio.com/api/references/vscode-api#window.Pseudoterminal )< br > [window.ExtensionTerminalOptions ](https://code.visualstudio.com/api/references/vscode-api#window.ExtensionTerminalOptions ) |
| [Color Theme Sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/theme-sample ) | [/api/extension-guides/color-theme ](https://code.visualstudio.com/api/extension-guides/color-theme ) | [contributes.themes ](https://code.visualstudio.com/api/references/contribution-points#contributes.themes ) |
2022-05-16 15:45:05 +08:00
| [Product Icon Theme Sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/product-icon-theme-sample ) | [/api/extension-guides/product-icon-theme ](https://code.visualstudio.com/api/extension-guides/product-icon-theme ) | [contributes.productIconThemes ](https://code.visualstudio.com/api/references/contribution-points#contributes.productIconThemes ) |
2021-02-22 09:58:22 -08:00
| [Vim Sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/vim-sample ) | N/A | [commands ](https://code.visualstudio.com/api/references/vscode-api#commands )< br > [StatusBarItem ](https://code.visualstudio.com/api/references/vscode-api#StatusBarItem )< br > [window.createStatusBarItem ](https://code.visualstudio.com/api/references/vscode-api#window.createStatusBarItem )< br > [TextEditorCursorStyle ](https://code.visualstudio.com/api/references/vscode-api#TextEditorCursorStyle )< br > [window.activeTextEditor ](https://code.visualstudio.com/api/references/vscode-api#window.activeTextEditor )< br > [Position ](https://code.visualstudio.com/api/references/vscode-api#Position )< br > [Range ](https://code.visualstudio.com/api/references/vscode-api#Range )< br > [Selection ](https://code.visualstudio.com/api/references/vscode-api#Selection )< br > [TextEditor ](https://code.visualstudio.com/api/references/vscode-api#TextEditor )< br > [TextEditorRevealType ](https://code.visualstudio.com/api/references/vscode-api#TextEditorRevealType )< br > [TextDocument ](https://code.visualstudio.com/api/references/vscode-api#TextDocument ) |
2024-06-27 09:58:24 -07:00
| [webpack-sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/webpack-sample ) | [/api/working-with-extensions/bundling-extension ](https://code.visualstudio.com/api/working-with-extensions/bundling-extension ) | |
| [esbuild-sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/esbuild-sample ) | [/api/working-with-extensions/bundling-extension ](https://code.visualstudio.com/api/working-with-extensions/bundling-extension ) | |
2021-02-22 09:58:22 -08:00
| [Source Control Sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/source-control-sample ) | [/api/extension-guides/scm-provider ](https://code.visualstudio.com/api/extension-guides/scm-provider ) | [workspace.workspaceFolders ](https://code.visualstudio.com/api/references/vscode-api#workspace.workspaceFolders )< br > [SourceControl ](https://code.visualstudio.com/api/references/vscode-api#SourceControl )< br > [SourceControlResourceGroup ](https://code.visualstudio.com/api/references/vscode-api#SourceControlResourceGroup )< br > [scm.createSourceControl ](https://code.visualstudio.com/api/references/vscode-api#scm.createSourceControl )< br > [TextDocumentContentProvider ](https://code.visualstudio.com/api/references/vscode-api#TextDocumentContentProvider )< br > [contributes.menus ](https://code.visualstudio.com/api/references/contribution-points#contributes.menus ) |
| [Commenting API Sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/comment-sample ) | N/A | |
| [Document Editing Sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/document-editing-sample ) | N/A | [commands ](https://code.visualstudio.com/api/references/vscode-api#commands ) |
| [Custom Data Sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/custom-data-sample ) | [/api/extension-guides/custom-data-extension ](https://code.visualstudio.com/api/extension-guides/custom-data-extension ) | |
| [CodeLens Provider Sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/codelens-sample ) | N/A | [languages.registerCodeLensProvider ](https://code.visualstudio.com/api/references/vscode-api#languages.registerCodeLensProvider )< br > [CodeLensProvider ](https://code.visualstudio.com/api/references/vscode-api#CodeLensProvider )< br > [CodeLens ](https://code.visualstudio.com/api/references/vscode-api#CodeLens ) |
| [Call Hierarchy Sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/call-hierarchy-sample ) | N/A | [languages.registerCallHierarchyProvider ](https://code.visualstudio.com/api/references/vscode-api#languages.registerCallHierarchyProvider )< br > [CallHierarchyProvider ](https://code.visualstudio.com/api/references/vscode-api#CallHierarchyProvider )< br > [CallHierarchyItem ](https://code.visualstudio.com/api/references/vscode-api#CallHierarchyItem )< br > [CallHierarchyOutgoingCall ](https://code.visualstudio.com/api/references/vscode-api#CallHierarchyOutgoingCall )< br > [CallHierarchyIncomingCall ](https://code.visualstudio.com/api/references/vscode-api#CallHierarchyIncomingCall ) |
| [Custom Editors Sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/custom-editor-sample ) | [/api/extension-guides/custom-editors ](https://code.visualstudio.com/api/extension-guides/custom-editors ) | [window.registerCustomEditorProvider ](https://code.visualstudio.com/api/references/vscode-api#window.registerCustomEditorProvider )< br > [CustomTextEditorProvider ](https://code.visualstudio.com/api/references/vscode-api#CustomTextEditorProvider )< br > [contributes.customEditors ](https://code.visualstudio.com/api/references/contribution-points#contributes.customEditors ) |
| [Semantic tokens ](https://github.com/Microsoft/vscode-extension-samples/tree/main/semantic-tokens-sample ) | [/api/language-extensions/semantic-highlight-guide ](https://code.visualstudio.com/api/language-extensions/semantic-highlight-guide ) | [languages.registerDocumentSemanticTokensProvider ](https://code.visualstudio.com/api/references/vscode-api#languages.registerDocumentSemanticTokensProvider )< br > [vscode.DocumentSemanticTokensProvider ](https://code.visualstudio.com/api/references/vscode-api#vscode.DocumentSemanticTokensProvider ) |
2022-06-27 17:06:11 -07:00
| [Test Provider Sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/test-provider-sample ) | N/A | |
| [Getting Started Sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/getting-started-sample ) | N/A | |
| [notebook-renderer-sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/notebook-renderer-sample ) | [/api/extension-guides/notebook#notebook-renderer ](https://code.visualstudio.com/api/extension-guides/notebook#notebook-renderer ) | [contributes.notebookRenderer ](https://code.visualstudio.com/api/references/contribution-points#contributes.notebookRenderer ) |
| [notebook-extend-markdown-renderer-sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/notebook-extend-markdown-renderer-sample ) | [/api/extension-guides/notebook#notebook-renderer ](https://code.visualstudio.com/api/extension-guides/notebook#notebook-renderer ) | [contributes.notebookRenderer ](https://code.visualstudio.com/api/references/contribution-points#contributes.notebookRenderer ) |
2024-06-27 09:58:24 -07:00
| [jupyter-server-provider-sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/jupyter-server-provider-sample ) | N/A | |
| [Chat Sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/chat-sample ) | N/A | |
2024-10-26 17:44:03 -07:00
| [Chat Tutorial ](https://github.com/Microsoft/vscode-extension-samples/tree/main/chat-tutorial ) | N/A | |
2024-06-27 09:58:24 -07:00
| [Notifications Sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/notifications-sample ) | N/A | |
2018-10-29 07:45:32 -07:00
<!-- SAMPLES_END -->
2021-08-15 10:30:00 +09:00
### Language Server Protocol Samples
2018-10-29 07:45:32 -07:00
<!-- LSP_SAMPLES_BEGIN -->
| Sample | Guide on VS Code Website | API & Contribution |
| ------ | ----- | --- |
2021-02-22 09:58:22 -08:00
| [Snippet Sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/snippet-sample ) | [/api/language-extensions/snippet-guide ](https://code.visualstudio.com/api/language-extensions/snippet-guide ) | [contributes.snippets ](https://code.visualstudio.com/api/references/contribution-points#contributes.snippets ) |
| [Language Configuration Sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/language-configuration-sample ) | [/api/language-extensions/language-configuration-guide ](https://code.visualstudio.com/api/language-extensions/language-configuration-guide ) | [contributes.languages ](https://code.visualstudio.com/api/references/contribution-points#contributes.languages ) |
| [LSP Sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/lsp-sample ) | [/api/language-extensions/language-server-extension-guide ](https://code.visualstudio.com/api/language-extensions/language-server-extension-guide ) | |
| [LSP Log Streaming Sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/lsp-log-streaming-sample ) | N/A | |
| [LSP Multi Root Server Sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/lsp-multi-server-sample ) | https://github.com/Microsoft/vscode/wiki/Extension-Authoring:-Adopting-Multi-Root-Workspace-APIs#language -client--language-server | |
2022-06-27 17:06:11 -07:00
| [LSP Web Extension Sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/lsp-web-extension-sample ) | [/api/language-extensions/language-server-extension-guide ](https://code.visualstudio.com/api/language-extensions/language-server-extension-guide ) | |
2024-06-27 09:58:24 -07:00
| [LSP User Input Sample ](https://github.com/Microsoft/vscode-extension-samples/tree/main/lsp-user-input-sample ) | N/A | |
2024-10-26 17:44:03 -07:00
| [LSP Embedded Language Service ](https://github.com/Microsoft/vscode-extension-samples/tree/main/lsp-embedded-language-service ) | N/A | |
| [LSP Embedded Request Forwarding ](https://github.com/Microsoft/vscode-extension-samples/tree/main/lsp-embedded-request-forwarding ) | N/A | |
| [Wasm language server ](https://github.com/Microsoft/vscode-extension-samples/tree/main/wasm-language-server ) | N/A | |
2018-10-29 07:45:32 -07:00
<!-- LSP_SAMPLES_END -->
2018-10-09 16:11:04 -07:00
2018-10-10 10:44:21 -07:00
## License
Copyright (c) Microsoft Corporation. All rights reserved.
2021-06-04 19:19:21 +01:00
Licensed under the [MIT ](https://github.com/microsoft/vscode-extension-samples/blob/main/LICENSE ) License.
