如何在“附加到运行中容器”后应用可共享的VS Code配置？

核心思路 #

不用让VS Code管理容器生命周期，而是直接附加到已运行容器，同时加载仓库中的.devcontainer/devcontainer.json配置。

具体步骤 #

• 在项目根目录创建.devcontainer文件夹，里面添加devcontainer.json，写入团队共享的配置，比如扩展、设置：

  {
    "extensions": [
      "ms-python.python",
      "dbaeumer.vscode-eslint"
    ],
    "settings": {
      "terminal.integrated.shell.linux": "/bin/bash",
      "python.pythonPath": "/usr/bin/python3"
    }
  }
  

• 禁用VS Code自动启动容器的行为，通过配置指定附加到已运行的服务：
  在devcontainer.json中添加dockerComposeFile指向你的现有Compose文件，同时设置service为目标服务名，关键是加上runServices和shutdownAction来控制容器生命周期：

  {
    "dockerComposeFile": "../docker-compose.yml", // 指向你的现有Compose文件路径
    "service": "your-target-service", // 要附加的服务名
    "runServices": [], // 空数组表示不启动任何服务
    "shutdownAction": "none", // 关闭Dev Container时不停止容器
    "extensions": [/* 你的扩展列表 */],
    "settings": {/* 你的设置 */}
  }
  

• 手动附加到已运行容器：

  • 确保你的Docker Compose服务已经启动（docker-compose up -d）
  • 在VS Code中打开项目根目录（包含.devcontainer的目录）
  • 打开命令面板（Ctrl+Shift+P/Cmd+Shift+P），执行Dev Containers: Reopen in Container
  • 此时VS Code会识别已运行的目标服务容器，直接附加并加载.devcontainer中的配置，不会重新启动容器

• 验证配置生效：
  附加后检查已安装的扩展是否和devcontainer.json中一致，设置是否正确应用

额外注意事项 #

• 如果你的Compose文件有多个，可在dockerComposeFile中传入数组，比如["../docker-compose.yml", "../docker-compose.override.yml"]
• 确保service字段和Compose文件中的服务名完全匹配
• 若容器内路径和本地项目路径映射有问题，可在devcontainer.json中添加workspaceFolder指定容器内的工作目录：

  "workspaceFolder": "/app" // 对应Compose中服务的volume挂载路径
  

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