Add skills for contributing commands and localization in VS Code extensions

This commit is contained in:
Alessandro Fragnani
2026-01-11 12:20:47 -03:00
parent 750dff407b
commit 090efd486c
3 changed files with 48 additions and 0 deletions

View File

@@ -0,0 +1,21 @@
---
name: vscode-ext-commands
description: 'Guidelines for contributing commands in VS Code extensions. Indicates naming convention, visibility, localization and other relevant attributes, following VS Code extension develoment 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 an `icon`, 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#sideBar` for instance. Must define an `icon`, and may or may not have some rule for `enablement`. Side Bar exclusive commands should not be visible in the Command Palette. Contributing it to the `view/title` or `view/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 correct `group` to be used. Also, it's a good practice define the condition (`when`) for the new command is visible.

View File

@@ -0,0 +1,25 @@
---
name: vscode-ext-localization
description: 'Guidelines for proper localization of VS Code extensions, following VS Code extension development guidelines, libraries and good practices'
---
# VS Code extension localization
This skill helps you localize every aspect of VS Code extensions
## When to use this skill
Use this skill when you need to:
- Localize new or existing contributed configurations (settings), commands, menus, views or walkthroughs
- Localize new or existing messages or other string resources contained in extension source code, that are used displayed to end user
# Instructions
VS Code localization is composed by three different approaches, depending on the resource that is being localized. When a new localizable resource is created or updated, the corresponding localization for all currently available languages must be created/updated.
1. Configurations like Settings, Commands, Menus, Views, ViewsWelcome, Walkthrough Titles and Descriptions, defined in `package.json`
-> An exclusive `package.nls.LANGID.json` file, like `package.nls.pt-br.json` of Brazilian Portuguese (`pt-br`) localization
2. Walkthough content (defined in its own `Markdown` files)
-> An exclusive `Markdown` file like `walkthrough/someStep.pt-br.md` for Brazilian Portuguese localization
3. Messages and string located in extension source code (JavaScript or TypeScript files)
-> An exclusive `bundle.l10n.pt-br.json` for Brazilian Portuguese localization