Activation Events | Visual Studio Code Extension API
AI agents: See llms.txt for documentation discovery and navigation. Documentation articles are also available as Markdown by appending .md to the article URL. 🎬 Watch The Story of VS Code! VS Code is now on Instagram, follow @vscode.ig for updates, tips, and more. Rewatch GitHub Copilot Day. Activation Events View as Markdown Ask in VS Code Ask in VS Code Insiders Activation Events is a set of JSON declarations that you make in the activationEvents field of package.json Extension Manifest .
Your extension becomes activated when the Activation Event happens. Here is a list of all available Activation Events : onAuthenticationRequest onChatParticipant onCommand onCustomEditor onDebug onDebugAdapterProtocolTracker onDebugDynamicConfigurations onDebugInitialConfigurations onDebugResolve onEditSession onFileSystem onIssueReporterOpened onLanguage onLanguageModelTool onNotebook onOpenExternalUri onRenderer onSearch onStartupFinished onTaskType onTerminal onTerminalProfile onTerminalShellIntegration onUri onView onWalkthrough onWebviewPanel workspaceContains * We also provide a reference of all fields in the package.json extension manifest . onLanguage This activation event is emitted and interested extensions will be activated whenever a file that resolves to a certain language gets opened.
"activationEvents" : [ "onLanguage:python" ] The onLanguage event takes a language identifier value. Multiple languages can be declared with separate onLanguage entries in the activationEvents array. "activationEvents" : [ "onLanguage:json" , "onLanguage:markdown" , "onLanguage:typescript" ] Note : Beginning with VS Code 1.74.0, languages contributed by your extension do not require a corresponding onLanguage activation event declaration for your extension to be activated.
Additionally, if your extension needs to be activated before any language is used, you can use the generic onLanguage activation event to ensure this: "activationEvents" : [ "onLanguage" ] Note : It is best practice to activate only when a user needs your extension. If your extension works on a subset of languages, it is better for the user to list that subset than to activate on all languages. onCommand This activation event is emitted and interested extensions will be activated whenever a command is being invoked: "activationEvents" : [ "onCommand:extension.sayHello" ] Note : Beginning with VS Code 1.74.0, commands contributed by your extension do not require a corresponding onCommand activation event declaration for your extension to be activated. onDebug This activation event is emitted and interested extensions will be activated before a debug session is started: "activationEvents" : [ "onDebug" ] These are four more fine-grained onDebug activation events: onDebugAdapterProtocolTracker onDebugAdapterProtocolTracker is emitted whenever a debug session with the specific type is about to be launched and a debug protocol tracker might be needed. onDebugDynamicConfigurations This activation event is emitted just before the provideDebugConfigurations method of the DebugConfigurationProvider is called to provide dynamic debug configurations when the user asks for them, such as through the UI via the "Select and Start Debugging" command.
The presence of this activation event is used as a signal that the extension contributes dynamic debug configurations. onDebugInitialConfigurations This activation event is emitted just before the provideDebugConfigurations method of the DebugConfigurationProvider is called to provide initial debug configurations, such as whenever a launch.json needs to be created. onDebugResolve onDebugResolve:type is fired just before the resolveDebugConfiguration method of the DebugConfigurationProvider for the specified type is called.
Rule of thumb: If activation of a debug extension is lightweight, use onDebug . If it is heavyweight, use onDebugInitialConfigurations and/or onDebugResolve depending on whether the DebugConfigurationProvider implements the corresponding methods provideDebugConfigurations and/or resolveDebugConfiguration . See Using a DebugConfigurationProvider for more details on these methods. workspaceContains workspaceContains:path is emitted and interested extensions will be activated whenever a folder is opened and the folder contains at least one file that matches a glob pattern .
"activationEvents" : [ "workspaceContains:**/.editorconfig" ] onFileSystem onFileSystem:scheme is emitted and interested extensions will be activated whenever a file or folder from a specific scheme is read. This is usually the file -scheme, but with custom file system providers more schemes come into place, e.g ftp or ssh . "activationEvents" : [ "onFileSystem:sftp" ] onView This activation event is emitted and interested extensions will be activated whenever a view of the specified id is expanded in the VS Code sidebar.
Built-in views do not emit an activation event. The activation event below will fire whenever a view with the nodeDependencies id is visible: "activationEvents" : [ "onView:nodeDependencies" ] Note : Beginning with VS Code 1.74.0, views contributed by your extension do not require a corresponding onView activation event declaration for your extension to be activated. onUri This activation event is emitted and interested extensions will be activated whenever a system-wide Uri for that extension is opened.
The Uri scheme is fixed to either vscode or vscode-insiders . The Uri authority must be the extension's identifier. The rest of the Uri is arbitrary. "activationEvents" : [ "onUri" ] If the vscode.git extension defines onUri as an activation event, it will be activated in any of the following Uris are open: vscode://vscode.git/init vscode://vscode.git/clone?url=https%3A%2F%2Fgithub.com%2FMicrosoft%2Fvscode-vsce.git vscode-insiders://vscode.git/init (for VS Code Insiders) onWebviewPanel This activation event is emitted and interested extensions will be activated whenever VS Code needs to restore a webview with the matching viewType .
For example, the declaration of onWebviewPanel below: "activationEvents" : [ "onWebviewPanel:catCoding" ] will cause the extension to be activated when VS Code needs to restore a webview with the viewType: catCoding . The viewType is set in the call to window.createWebviewPanel and you will need to have another activation event (for example, onCommand) to initially activate your extension and create the webview. onCustomEditor This activation event is emitted and interested extensions will be activated whenever VS Code needs to create a custom editor with the matching viewType .
For example, the declaration of onCustomEditor below: "activationEvents" : [ "onCustomEditor:catCustoms.pawDraw" ] will cause the extension to be activated when VS Code needs to restore a custom editor with the viewType: catCustoms.pawDraw . The viewType is set in the customEditors contribution point and bound to a provider with registerCustomEditorProvider . Note : Beginning with VS Code 1.74.0, custom editors contributed by your extension do not require a corresponding onCustomEditor activation event declaration for your extension to be activated. onAuthenticationRequest This activation event is emitted and interested extensions will be activated whenever an extension requests an authentication session (via the authentication.getSession() API) with the matching providerId .
For example, the declaration of onAuthenticationRequest below: "activationEvents" : [ "onAuthenticationRequest:github" ] will cause the extension to be activated when VS Code needs retrieve an AuthenticationSession of type github . Note : Beginning with VS Code 1.74.0, authentication providers contributed by your extension do not require a corresponding onAuthenticationRequest activation event declaration for your extension to be activated. onStartupFinished This activation event is emitted and interested extensions will be activated some time after VS Code starts up.
This is similar to t
The rest of this page is on the live site.