1.5 KiB
name, description
| name | description |
|---|---|
| vscode-ext-commands | Guidelines for contributing commands in VS Code extensions. Indicates naming convention, visibility, localization and other relevant attributes, following VS Code extension development guidelines, libraries and good practices |
VS Code extension command contribution
This skill helps you to contribute commands in VS Code extensions
When to use this skill
Use this skill when you need to:
- Add or update commands to your VS Code extension
Instructions
VS Code commands must always define a title, independent of its category, visibility or location. We use a few patterns for each "kind" of command, with some characteristics, described below:
-
Regular commands: By default, all commands should be accessible in the Command Palette, must define a
category, and don't need anicon, unless the command will be used in the Side Bar. -
Side Bar commands: It's name follow a special pattern, starting with underscore (
_) and suffixed with#sideBar, like_extensionId.someCommand#sideBarfor instance. Must define anicon, and may or may not have some rule forenablement. Side Bar exclusive commands should not be visible in the Command Palette. Contributing it to theview/titleorview/item/context, we must inform order/position that it will be displayed, and we can use terms "relative to other command/button" in order to you identify the correctgroupto be used. Also, it's a good practice to define the condition (when) for the new command is visible.