激活事件

激活事件 是你在 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

每当扩展通过 authentication.getSession() API 请求匹配 providerId 的认证会话时，此激活事件就会发出，并激活感兴趣的扩展。

例如，下面的 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"
]

onTerminalProfile

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

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

onWalkthrough

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

"activationEvents": [
    "onWalkthrough:nodejsWelcome"
]

onIssueReporterOpened

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

"activationEvents": [
    "onIssueReporterOpened"
]

onChatParticipant

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

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

onLanguageModelTool

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

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

启动

每当 VS Code 启动时，* 激活事件就会发出，并激活感兴趣的扩展。

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

"activationEvents": [
    "*"
]

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

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

07/09/2025