编辑

激活事件

激活事件是你在 package.json 的 activationEvents 字段中进行的一组 JSON 声明（参见扩展清单）。当激活事件发生时，你的扩展就会被激活。以下是所有可用激活事件的列表：

我们还提供了package.json 扩展清单中所有字段的参考。

onLanguage

当一个文件解析为某种语言并被打开时，此激活事件会被触发，相关扩展将被激活。

"activationEvents": [
    "onLanguage:python"
]

onLanguage 事件接受一个语言标识符值。

可以在 activationEvents 数组中通过单独的 onLanguage 条目声明多种语言。

"activationEvents": [
    "onLanguage:json",
    "onLanguage:markdown",
    "onLanguage:typescript"
]

注意：从 VS Code 1.74.0 开始，你的扩展贡献的语言不再需要相应的 onLanguage 激活事件声明即可激活你的扩展。

此外，如果你的扩展需要在任何语言使用之前激活，你可以使用通用的 onLanguage 激活事件来确保这一点。

"activationEvents": [
    "onLanguage"
]

注意：最佳实践是仅在用户需要你的扩展时才激活。如果你的扩展适用于某个语言子集，那么列出该子集比在所有语言上都激活对用户更好。

onCommand

当一个命令被调用时，此激活事件会被触发，相关扩展将被激活。

"activationEvents": [
    "onCommand:extension.sayHello"
]

注意：从 VS Code 1.74.0 开始，你的扩展贡献的命令不再需要相应的 onCommand 激活事件声明即可激活你的扩展。

onDebug

在调试会话启动之前，此激活事件会被触发，相关扩展将被激活。

"activationEvents": [
    "onDebug"
]

以下是四个更细粒度的 onDebug 激活事件：

onDebugAdapterProtocolTracker

当即将启动特定类型的调试会话且可能需要调试协议跟踪器时，会触发 onDebugAdapterProtocolTracker。

onDebugDynamicConfigurations

当用户请求动态调试配置时，例如通过“选择并开始调试”命令通过 UI 请求，此激活事件会在调用 DebugConfigurationProvider 的 provideDebugConfigurations 方法以提供动态调试配置之前触发。

此激活事件的存在被用作扩展贡献动态调试配置的信号。

onDebugInitialConfigurations

当需要创建 launch.json 等初始调试配置时，此激活事件会在调用 DebugConfigurationProvider 的 provideDebugConfigurations 方法以提供初始调试配置之前触发。

onDebugResolve

onDebugResolve:type 在调用指定类型的 DebugConfigurationProvider 的 resolveDebugConfiguration 方法之前触发。

经验法则：如果调试扩展的激活是轻量级的，请使用 onDebug。如果它是重量级的，请根据 DebugConfigurationProvider 是否实现相应的 provideDebugConfigurations 和/或 resolveDebugConfiguration 方法来使用 onDebugInitialConfigurations 和/或 onDebugResolve。有关这些方法的更多详细信息，请参阅使用 DebugConfigurationProvider。

workspaceContains

当打开一个文件夹且该文件夹包含至少一个与 glob 模式匹配的文件时，workspaceContains:path 会被触发，相关扩展将被激活。

"activationEvents": [
    "workspaceContains:**/.editorconfig"
]

onFileSystem

当从特定方案读取文件或文件夹时，onFileSystem:scheme 会被触发，相关扩展将被激活。这通常是 file 方案，但对于自定义文件系统提供程序，会引入更多方案，例如 ftp 或 ssh。

"activationEvents": [
    "onFileSystem:sftp"
]

onView

当 VS Code 侧边栏中展开指定 ID 的视图时，此激活事件会被触发，相关扩展将被激活。内置视图不触发激活事件。

以下激活事件将在 ID 为 nodeDependencies 的视图可见时触发：

"activationEvents": [
    "onView:nodeDependencies"
]

注意：从 VS Code 1.74.0 开始，你的扩展贡献的视图不再需要相应的 onView 激活事件声明即可激活你的扩展。

onUri

当该扩展的系统级 Uri 被打开时，此激活事件会被触发，相关扩展将被激活。Uri 方案固定为 vscode 或 vscode-insiders。Uri 权限必须是扩展的标识符。Uri 的其余部分是任意的。

"activationEvents": [
    "onUri"
]

如果 vscode.git 扩展将 onUri 定义为激活事件，则在打开以下任何 Uri 时，它将被激活：

vscode://vscode.git/init
vscode://vscode.git/clone?url=https%3A%2F%2Fgithub.com%2FMicrosoft%2Fvscode-vsce.git
vscode-insiders://vscode.git/init（适用于 VS Code Insiders）

onWebviewPanel

当 VS Code 需要恢复具有匹配 viewType 的Webview时，此激活事件会被触发，相关扩展将被激活。

例如，下面 onWebviewPanel 的声明：

"activationEvents": [
    "onWebviewPanel:catCoding"
]

将导致扩展在 VS Code 需要恢复 viewType: catCoding 的 Webview 时被激活。viewType 在调用 window.createWebviewPanel 时设置，你将需要另一个激活事件（例如 onCommand）来最初激活你的扩展并创建 Webview。

onCustomEditor

当 VS Code 需要创建具有匹配 viewType 的自定义编辑器时，此激活事件会被触发，相关扩展将被激活。

例如，下面 onCustomEditor 的声明：

"activationEvents": [
    "onCustomEditor:catCustoms.pawDraw"
]

将导致扩展在 VS Code 需要恢复 viewType: catCustoms.pawDraw 的自定义编辑器时被激活。viewType 在customEditors 贡献点中设置，并通过 registerCustomEditorProvider 绑定到提供程序。

注意：从 VS Code 1.74.0 开始，你的扩展贡献的自定义编辑器不再需要相应的 onCustomEditor 激活事件声明即可激活你的扩展。

onAuthenticationRequest

当扩展请求具有匹配 providerId 的身份验证会话（通过 authentication.getSession() API）时，此激活事件会被触发，相关扩展将被激活。

例如，下面 onAuthenticationRequest 的声明：

"activationEvents": [
    "onAuthenticationRequest:github"
]

将导致扩展在 VS Code 需要检索 github 类型的 AuthenticationSession 时被激活。

注意：从 VS Code 1.74.0 开始，你的扩展贡献的身份验证提供程序不再需要相应的 onAuthenticationRequest 激活事件声明即可激活你的扩展。

onStartupFinished

此激活事件会在 VS Code 启动一段时间后触发，相关扩展将被激活。这类似于 * 激活事件，但它不会减慢 VS Code 的启动速度。目前，此事件在所有 * 激活的扩展完成激活后触发。

"activationEvents": [
    "onStartupFinished"
]

onTaskType

当需要列出或解析特定类型的任务时，会触发 onTaskType:type。

"activationEvents": [
    "onTaskType:npm"
]

注意：从 VS Code 1.76.0 开始，你的扩展贡献的任务不再需要相应的 onTaskType 激活事件声明即可激活你的扩展。

onEditSession

当使用给定方案访问编辑会话时，会触发 onEditSession:scheme。

"activationEvents": [
    "onEditSession:file"
]

onSearch

当在具有给定方案的文件夹中开始搜索时，会触发 onSearch:scheme。

"activationEvents": [
    "onSearch:file"
]

onOpenExternalUri

当打开外部 URI（例如 HTTP 或 HTTPS 链接）时，会触发激活事件。

"activationEvents": [
    "onOpenExternalUri"
]

onNotebook

当打开指定的笔记本文档类型时，会触发 onNotebook:type。

"activationEvents": [
    "onNotebook:jupyter-notebook",
    "onNotebook:interactive"
]

onRenderer

当使用笔记本输出渲染器时，会触发 onRenderer:id。

"activationEvents": [
    "onRenderer:ms-toolsai.jupyter-renderers"
]

onTerminal

当打开具有给定 shell 类型的特定终端时，会触发 onTerminal:shellType。

"activationEvents": [
  "onTerminal:bash"
]

onTerminalProfile

当启动特定的终端配置文件时，会触发 onTerminalProfile:id。

"activationEvents": [
    "onTerminalProfile:terminalTest.terminal-profile"
]

onTerminalShellIntegration

当具有给定 shell 类型的终端激活 shell 集成时，会触发 onTerminalShellIntegration:shellType。

"activationEvents": [
    "onTerminalShellIntegration:bash"
]

onWalkthrough

当打开指定的演练时，会触发 onWalkthrough:id。

"activationEvents": [
    "onWalkthrough:nodejsWelcome"
]

onIssueReporterOpened

当问题报告器打开时（例如，通过使用帮助：报告问题），此激活事件会被触发。

"activationEvents": [
    "onIssueReporterOpened"
]

onChatParticipant

当调用指定的聊天参与者时，会触发激活事件。

"activationEvents": [
    "onChatParticipant:my-chat-participant"
]

onLanguageModelTool

当调用指定的语言模型工具时，会触发激活事件。

"activationEvents": [
    "onLanguageModelTool:my-language-model-tool"
]

启动

当 VS Code 启动时，* 激活事件会被触发，相关扩展将被激活。

注意：为了确保出色的用户体验，仅当你的用例中没有其他激活事件组合有效时，才在你的扩展中使用此激活事件。

"activationEvents": [
    "*"
]

注意：一个扩展可以监听多个激活事件，这比监听 "*" 更可取。

注意：扩展必须从其主模块导出 activate() 函数，并且当任何指定的激活事件触发时，VS Code 将仅调用一次该函数。此外，扩展应该从其主模块导出 deactivate() 函数，以便在 VS Code 关闭时执行清理任务。如果清理过程是异步的，扩展必须从 deactivate() 返回一个 Promise。如果清理是同步运行的，扩展可以从 deactivate() 返回 undefined。

09/11/2025