ExtArch short for Extension Architecture is a tool to help you create a new extension for Visual Studio Code. It provides a comprehensive architecture for your extension and a set of tools to help you develop and test your extension.
1 - Create your command in the
constant.commands.tsfile
export const CommandId = {
YourCommandName: "[package-name].[cmdYourCommandName]",
};2 - Configure your command interaction in the
package.jsonin theContributes section
"contributes": {
"commands": [
{
"command": "[package-name].[cmdYourCommandName]",
"title": "Your Command Name",
"category": "ExtArch"
}
],
"keybindings": [
{
"command": "[package-name].[cmdYourCommandName]",
"key": "your shortcut",
}
],
"menus": {
"commandPalette": [
{
"command": "[package-name].[cmdYourCommandName]",
"when": "true"
},
]
}
},3 - Implement your command in the
src/providers/commandsfolder.
- Create your command file name with the same of your command name for consistency.
- File:
cmdYourCommandName.command.ts- Example of a command implementation:
export const cmdYourCommandName = new Command(CommandId.HelloTwitch, yourCommandName);
function yourCommandName() {
vscode.window.showInformationMessage("Hello From My Command!");
}
- In the
new Command classyou can also pass an extra parameter (boolean) to the constructor to specify if the command is going to be executed in the Extension Activation event. The default value isfalse, making the command to be executed only when the user calls it.
4 - Register your command in the
commandManager.provider.tsfile. Just add your command in theaddRegisteredCommands array:
/* Register all commands */
private addRegisteredCommands() {
/* Add new commands here */
this._registeredCommands.push(cmdYourCommandName);
}To create an extension make sure you have the most up to date scaffold tool installed:
npm install -g yo generator-codeCreating an extension:
yo codeMake sure you select the TypeScript option.
Calling out known issues can help limit users opening duplicate issues against your extension.
Open issues Here
Initial release of the command architecture.
Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.
You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
- Split the editor (
Cmd+\on macOS orCtrl+\on Windows and Linux). - Toggle preview (
Shift+Cmd+Von macOS orShift+Ctrl+Von Windows and Linux). - Press
Ctrl+Space(Windows, Linux, macOS) to see a list of Markdown snippets.
Enjoy!