In this topic, we'll teach you the fundamental concepts for building extensions. Make sure you have Node.js and Git installed, then install Yeoman and VS Code Extension Generator with:
HTML in Visual Studio Code. Visual Studio Code provides basic support for HTML programming out of the box. There is syntax highlighting, smart completions with IntelliSense, and customizable formatting. VS Code also includes great Emmet support. As you type in HTML, we offer suggestions via HTML IntelliSense.
The generator scaffolds a TypeScript or JavaScript project ready for development. Run the generator and fill out a few fields for a TypeScript project:
Then, inside the editor, press F5. This will compile and run the extension in a new Extension Development Host window.
Run the Hello World command from the Command Palette (⇧⌘P (Windows, Linux Ctrl+Shift+P)) in the new window:
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. In this article, I’ll focus on a list of must-have VS Code extensions for JavaScript developers. Visual Studio Code (VS Code) is undoubtedly the most popular, lightweight code editor today.
You should see the Hello World from HelloWorld!
notification showing up. Success!
Let's make a change to the message:
Hello World from HelloWorld!
to Hello VS Code
in extension.ts
You should see the updated message showing up.
Here are some ideas for you to try:
vscode.window.showInformationMessage
with another VS Code API call to show a warning message.VS Code's built-in debugging functionality makes it easy to debug extensions. Set a breakpoint by clicking the gutter next to a line, and VS Code will hit the breakpoint. You can hover over variables in the editor or use the Run view in the left to check a variable's value. The Debug Console allows you to evaluate expressions.
You can learn more about debugging Node.js apps in VS Code in the Node.js Debugging Topic.
In the next topic, Extension Anatomy, we'll take a closer look at the source code of the Hello World
sample and explain key concepts.
You can find the source code of this tutorial at: https://github.com/microsoft/vscode-extension-samples/tree/master/helloworld-sample. The Extension Guides topic contains other samples, each illustrating a different VS Code API or Contribution Point.
In this guide, we mainly describe how to develop VS Code extension with TypeScript because we believe TypeScript offers the best experience for developing VS Code extensions. However, if you prefer JavaScript, you can still follow along using helloworld-minimal-sample.
Increase the power of Visual Studio Code through Extensions
The features that Visual Studio Code includes out-of-the-box are just the start. VS Code extensions let you add languages, debuggers, and tools to your installation to support your development workflow. VS Code's rich extensibility model lets extension authors plug directly into the VS Code UI and contribute functionality through the same APIs used by VS Code. This topic explains how to find, install, and manage VS Code extensions from the Visual Studio Code Marketplace.
You can browse and install extensions from within VS Code. Bring up the Extensions view by clicking on the Extensions icon in the Activity Bar on the side of VS Code or the View: Extensions command (⇧⌘X (Windows, Linux Ctrl+Shift+X)).
This will show you a list of the most popular VS Code extensions on the VS Code Marketplace.
Each extension in the list includes a brief description, the publisher, the download count, and a five star rating. You can click on the extension item to display the extension's details page where you can learn more.
Note: If your computer's Internet access goes through a proxy server, you will need to configure the proxy server. See Proxy server support for details.
To install an extension, click the Install button. Once the installation is complete, the Install button will change to the Manage gear button.
On the extension details page, you can read the extension's README as well as review the extension's:
If an extension is an Extension Pack, the Extension Pack section will display which extensions will be installed when you install the pack. Extension Packs bundle separate extensions together so they can be easily installed at one time.
You can run various Extensions view commands by clicking on the Extensions view's ...
More Actions button.
There are commands to show:
You can sort the extension list by Install Count or Rating in either ascending or descending order. You can learn more about extension search filters below.
You can clear the Search box at the top of the Extensions view and type in the name of the extension, tool, or programming language you're looking for.
For example, typing 'python' will bring up a list of Python language extensions:
If you know the exact identifier for an extension you're looking for, you can use the @id:
prefix, for example @id:octref.vetur
. Additionally, to filter or sort results, you can use the filter and sort commands, detailed below.
VS Code makes it easy to manage your extensions. You can install, disable, update, and uninstall extensions through the Extensions view, the Command Palette (commands have the Extensions: prefix) or command-line switches.
By default, the Extensions view will show the extensions you currently have enabled, all extensions that are recommended for you, and a collapsed view of all extensions you have disabled. You can use the Show Installed Extensions command, available in the Command Palette (⇧⌘P (Windows, Linux Ctrl+Shift+P)) or the More Actions (...
) drop-down menu, to clear any text in the search box and show the list of all installed extensions, which includes those that have been disabled.
To uninstall an extension, click the gear button at the right of an extension entry and then choose Uninstall from the drop-down menu. This will uninstall the extension and prompt you to reload VS Code.
If you don't want to permanently remove an extension, you can instead temporarily disable the extension by clicking the gear button at the right of an extension entry. You can disable an extension globally or just for your current Workspace. You will be prompted to reload VS Code after you disable an extension.
If you want to quickly disable all installed extensions, there is a Disable All Installed Extensions command in the Command Palette and More Actions (...
) drop-down menu.
Extensions remain disabled for all VS Code sessions until you re-enable them.
Similarly if you have disabled an extension (it will be in the Disabled section of the list and marked Disabled), you can re-enable it with the Enable or Enable (Workspace) commands in the drop-down menu.
There is also an Enable All Extensions command in the More Actions (...
) drop-down menu.
VS Code checks for extension updates and installs them automatically. After an update, you will be prompted to reload VS Code. If you'd rather update your extensions manually, you can disable auto-update with the Disable Auto Updating Extensions command that sets the extensions.autoUpdate
setting to false
. If you don't want VS Code to even check for updates, you can set the extensions.autoCheckUpdates
setting to false.
If you have extensions auto-update disabled, you can quickly look for extension updates by using the Show Outdated Extensions command that uses the @outdated
filter. This will display any available updates for your currently installed extensions. Click the Update button for the outdated extension and the update will be installed and you'll be prompted to reload VS Code. You can also update all your outdated extensions at one time with the Update All Extensions command. If you also have automatic checking for updates disabled, you can use the Check for Extension Updates command to check which of your extensions can be updated.
You can see a list of recommended extensions using Show Recommended Extensions, which sets the @recommended
filter. Extension recommendations can either be:
See the section below to learn how to contribute recommendations for other users in your project.
To dismiss a recommendation, click on the extension item to open the Details pane and then press the Ignore Recommendation button. Ignored recommendations will no longer be recommended to you.
VS Code extensions may have very different configurations and requirements. Some extensions contribute settings to VS Code, which can be modified in the Settings editor. Other extensions may have their own configuration files. Extensions may also require installation and setup of additional components like compilers, debuggers, and command-line tools. Consult the extension's README (visible in the Extensions view details page) or go to the extension page on the VS Code Marketplace (click on the extension name in the details page). Many extensions are open source and have a link to their repository on their Marketplace page.
To make it easier to automate and configure VS Code, it is possible to list, install, and uninstall extensions from the command line. When identifying an extension, provide the full name of the form publisher.extension
, for example ms-python.python
.
Example:
You can see the extension ID on the extension details page next to the extension name.
The Extensions view search box supports filters to help you find and manage extensions. You may have seen filters such as @installed
and @recommended
if you used the commands Show Installed Extensions and Show Recommended Extensions. Also, there are filters available to let you sort by popularity or ratings and search by category (for example 'Linters') and tags (for example 'node'). You can see a complete listing of all filters and sort commands by typing @
in the extensions search box and navigating through the suggestions:
Here are the Extensions view filters:
@builtin
- Show extensions that come with VS Code. Grouped by type (Programming Languages, Themes, etc.).@disabled
- Show disabled installed extensions.@installed
- Show installed extensions.@outdated
- Show outdated installed extensions. A newer version is available on the Marketplace.@enabled
- Show enabled installed extensions. Extensions can be individually enabled/disabled.@recommended
- Show recommended extensions. Grouped as Workspace specific or general use.@category
- Show extensions belonging to specified category. Below are a few of supported categories. For a complete list, type @category
and follow the options in the suggestion list: @category:themes
@category:formatters
@category:linters
@category:snippets
These filters can be combined as well. For example: Use @installed @category:themes
to view all installed themes.
If no filter is provided, the Extensions view displays the currently installed and recommended extensions.
You can sort extensions with the @sort
filter, which can take the following values:
installs
- Sort by Marketplace installation count, in descending order.rating
- Sort by Marketplace rating (1-5 stars), in descending order.name
- Sort alphabetically by extension name.Extensions can set Categories and Tags describing their features.
You can filter on category and tag by using category:
and tag:
.
Supported categories are: [Programming Languages, Snippets, Linters, Themes, Debuggers, Formatters, Keymaps, SCM Providers, Other, Extension Packs, Language Packs, Data Science, Machine Learning, Visualization, Notebooks]
. They can be accessed through IntelliSense in the extensions search box:
Note that you must surround the category name in quotes if it is more than one word (for example, category:'SCM Providers'
).
Tags may contain any string and are not provided by IntelliSense, so review the Marketplace to find helpful tags.
You can manually install a VS Code extension packaged in a .vsix
file. Using the Install from VSIX command in the Extensions view command drop-down, or the Extensions: Install from VSIX command in the Command Palette, point to the .vsix
file.
You can also install using the VS Code --install-extension
command-line switch providing the path to the .vsix
file.
You may provide the --install-extension
multiple times on the command line to install multiple extensions at once.
If you'd like to learn more about packaging and publishing extensions, see our Publishing Extensions topic in the Extension API.
A good set of extensions can make working with a particular workspace or programming language more productive and you'd often like to share this list with your team or colleagues. You can create a recommended list of extensions for a workspace with the Extensions: Configure Recommended Extensions (Workspace Folder) command.
In a single folder workspace, the command creates an extensions.json
file located in the workspace .vscode
folder where you can add a list of extensions identifiers ({publisherName}.{extensionName}).
In a multi-root workspace, the command will open your .code-workspace
file where you can list extensions under extensions.recommendations
. You can still add extension recommendations to individual folders in a multi-root workspace by using the Extensions: Configure Recommended Extensions (Workspace Folder) command.
An example extensions.json
could be:
which recommends a linter extension, ESLint, and the Chrome debugger extension.
An extension is identified using its publisher name and extension identifier publisher.extension
. You can see the name on the extension's detail page. VS Code will provide you with auto-completion for installed extensions inside these files.
.
VS Code prompts a user to install the recommended extensions when a workspace is opened for the first time. The user can also review the list with the Extensions: Show Recommended Extensions command.
Here are a few topics you may find interesting...
Extensions are installed in a per user extensions folder. Depending on your platform, the location is in the following folder:
%USERPROFILE%.vscodeextensions
~/.vscode/extensions
~/.vscode/extensions
You can change the location by launching VS Code with the --extensions-dir <dir>
command-line option.
You may see this error if your machine is going through a proxy server to access the Internet. See the Proxy server support section in the setup topic for details.
Some users prefer to download an extension once from the Marketplace and then install it multiple times from a local share. This is useful when there are connectivity concerns or if your development team wants to use a fixed set of extensions.
To download an extension, navigate to the details page for the specific extension within the Marketplace. On that page, there is a Download Extension link in the Resources section, which is located on the right-hand side of the page.
Once downloaded, you can then install the extension via the Install from VSIX command in the Extensions view command drop-down.
Yes, if you would prefer to not have VS Code display extension recommendations in the Extensions view or through notifications, you can modify the following settings:
extensions.showRecommendationsOnlyOnDemand
- Set to true to remove the RECOMMENDED section.extensions.ignoreRecommendations
- Set to true to silence extension recommendation notifications.The Show Recommended Extensions command is always available if you wish to see recommendations.
The Marketplace runs a virus scan on each extension package that's published to ensure its safety. The virus scan is run for each new extension and for each extension update. Until the scan is all clear, the extension won't be published in the Marketplace for public usage.
The Marketplace also prevents extension authors from name-squatting on official publishers such as Microsoft and RedHat.
If a malicious extension is reported and verified, or a vulnerability is found in an extension dependency:
The Marketplace also provides you with resources to make an informed decision about the extensions you install:
If you do see an extension that looks suspicious, you can report the extension to the Marketplace with the Report Abuse link at the bottom of the extension More Info section.