Visual Studio Code Terminals 扩展教程

Visual Studio Code Terminals 扩展教程

vscode-terminalsAn extension for setting-up multiple terminals at once, or just running some commands.项目地址:https://gitcode.com/gh_mirrors/vs/vscode-terminals

1. 项目的目录结构及介绍

Visual Studio Code Terminals 扩展的目录结构如下：

vscode-terminals/
├── README.md
├── package.json
├── src/
│   ├── extension.ts
│   └── terminals.json
├── out/
│   ├── extension.js
│   └── terminals.json
└── media/
    └── icon.png

• README.md: 项目说明文件，包含项目的基本信息和使用指南。
• package.json: 项目的元数据文件，包含依赖项、脚本和扩展配置。
• src/: 源代码目录，包含扩展的主要逻辑。
  • extension.ts: 扩展的主文件，负责注册命令和处理用户交互。
  • terminals.json: 终端配置文件，定义了多个终端的设置。
• out/: 编译后的代码目录，包含用于发布的 JavaScript 文件。
  • extension.js: 编译后的扩展主文件。
  • terminals.json: 编译后的终端配置文件。
• media/: 媒体文件目录，包含扩展使用的图标。
  • icon.png: 扩展的图标文件。

2. 项目的启动文件介绍

项目的启动文件是 src/extension.ts，它负责注册扩展的命令和处理用户交互。以下是该文件的主要功能：

• 注册命令: 注册 Terminals: Edit Configuration、Terminals: Kill、Terminals: Run 和 Terminals: Run Single 等命令。
• 处理用户交互: 处理用户通过命令面板或快捷键触发的事件，如打开配置文件、运行终端等。

3. 项目的配置文件介绍

项目的配置文件是 src/terminals.json，它定义了多个终端的设置。以下是该文件的主要内容：

{
  "autorun": true,
  "autokill": true,
  "env": {
    "name": "value"
  },
  "terminals": [
    {
      "name": "My Terminal",
      "description": "A terminal that runs some commands",
      "icon": "code",
      "color": "terminal.ansiCyan",
      "cwd": "/Users/fabio/Desktop",
      "command": "whoami",
      "commands": [
        "cd to/my/chest",
        "touch my_heart"
      ],
      "target": "My Other Terminal",
      "split": "My Parent Terminal",
      "persistent": true
    }
  ]
}

• autorun: 是否在启动时自动执行 Terminals: Run 命令。
• autokill: 是否在项目从工作区移除时终止所有终端。
• env: 全局环境变量，应用于所有终端。
• terminals: 终端配置数组，每个终端包含以下属性：
  • name: 终端的名称。
  • description: 终端的描述。
  • icon: 终端的图标。
  • color: 终端的颜色。
  • cwd: 终端的当前工作目录。
  • command: 单个命令。
  • commands: 多个命令。
  • target: 执行命令的目标终端。
  • split: 从哪个终端分割。
  • persistent: 是否为持久终端。

通过以上配置，用户可以自定义多个终端并在 Visual Studio Code 中快速启动和管理它们。

vscode-terminalsAn extension for setting-up multiple terminals at once, or just running some commands.项目地址:https://gitcode.com/gh_mirrors/vs/vscode-terminals