如何在VSCode的launch.json runtimeArgs中引用.env环境变量

你遇到的空值问题符合VSCode调试配置的预设逻辑：envFile配置的作用是将.env文件内的变量注入到后续启动的Node调试进程中，而launch.json内的${env:XXX}占位符是VSCode在解析配置、启动进程之前就完成替换的，此时envFile还未被加载，因此无法读取到文件内定义的变量，只能拿到空值。

下面给出3种不同复杂度的实现方案，可根据你的项目需求选择：

方案1：通过终端shell预加载.env（无额外依赖，适合macOS/Linux环境） #

直接将运行时执行程序改为shell，在启动sst前先加载.env文件读取变量：

{
    "name": "Debug SST Start",
    "type": "node",
    "request": "launch",
    "runtimeExecutable": "/bin/bash",
    "runtimeArgs": [
        "-c",
        "source ${workspaceFolder}/.env && ${workspaceRoot}/node_modules/.bin/sst start --increase-timeout --stage $DWAM_STAGE_NAME"
    ],
    "console": "integratedTerminal",
    "skipFiles": ["<node_internals>/**"]
}

Windows环境可将runtimeExecutable改为powershell，对应runtimeArgs调整为：

"runtimeArgs": [
  "-Command",
  "Get-Content ${workspaceFolder}/.env | ForEach-Object { $name, $value = $_.split('=', 2); Set-Item env:\\$name $value } & ${workspaceRoot}/node_modules/.bin/sst start --increase-timeout --stage $env:DWAM_STAGE_NAME"
]

方案2：借助dotenv-cli实现跨平台兼容（推荐） #

先在项目中安装dotenv-cli工具，用于提前加载.env变量：

npm install -D dotenv-cli

修改launch.json配置如下：

{
    "name": "Debug SST Start",
    "type": "node",
    "request": "launch",
    "runtimeExecutable": "${workspaceRoot}/node_modules/.bin/dotenv",
    "runtimeArgs": [
        "-e",
        "${workspaceFolder}/.env",
        "--",
        "sst",
        "start",
        "--increase-timeout",
        "--stage",
        "$DWAM_STAGE_NAME"
    ],
    "console": "integratedTerminal",
    "skipFiles": ["<node_internals>/**"]
}

该方案无需适配不同操作系统的shell语法，跨项目复用性更强。

方案3：在launch.json中显式声明变量（适合变量少、无需频繁变更的场景） #

如果涉及的环境变量数量不多，可直接在launch.json的env字段中重复声明变量值，此时${env:XXX}占位符可正常读取到配置内声明的变量：

{
    "name": "Debug SST Start",
    "type": "node",
    "request": "launch",
    "env": {
        "DWAM_STAGE_NAME": "MY_VAR_CONTENT"
    },
    "envFile": "${workspaceFolder}/.env",
    "runtimeExecutable": "${workspaceRoot}/node_modules/.bin/sst",
    "runtimeArgs": ["start", "--increase-timeout", "--stage", "${env:DWAM_STAGE_NAME}"],
    "console": "integratedTerminal",
    "skipFiles": ["<node_internals>/**"]
}

注意该方案需要保证env字段声明的变量和.env文件内的值同步，否则会出现配置不一致的问题。

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