VSCode扩展开发：如何判断当前窗口是否连接远程或Dev Container？

官方API直接判断 #

VSCode提供了原生API可以直接获取当前环境的远程状态，这是最可靠的方案：

• 使用vscode.env.remoteName属性：

  • 本地环境：值为undefined
  • Dev Container：值为"dev-container"
  • SSH远程：值为"ssh"
  • WSL环境：值为"wsl"

  示例代码：

import * as vscode from 'vscode';

function detectEnvironment() {
    const remoteType = vscode.env.remoteName;
    switch (remoteType) {
        case undefined:
            // 执行本地环境的配置逻辑
            break;
        case 'dev-container':
            // 执行Dev Container专属配置逻辑
            break;
        case 'ssh':
        case 'wsl':
            // 执行通用远程环境的配置逻辑
            break;
        default:
            // 处理其他少见的远程类型
            break;
    }
}

补充验证（针对Dev Container） #

如果需要更精准地确认Dev Container环境，可以读取专属配置：

const containerWorkspace = vscode.workspace.getConfiguration('remote.containers').get<string>('containerWorkspaceFolder');
if (containerWorkspace) {
    // 确认处于Dev Container中
}

版本注意事项 #

vscode.env.remoteName从VSCode 1.50版本开始支持，建议将扩展的最低目标版本设置为1.50及以上，避免兼容性问题。

内容的提问来源于stack exchange，提问作者Kodakrome