VSCode Bash Debug 项目教程

VSCode Bash Debug 项目教程

vscode-bash-debugBash shell debugger extension for VSCode (based on bashdb)项目地址:https://gitcode.com/gh_mirrors/vs/vscode-bash-debug

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

vscode-bash-debug/
├── .github/
│   └── ISSUE_TEMPLATE/
├── .vscode/
│   └── launch.json
├── assets/
│   └── images/
├── bashdb/
│   ├── lib/
│   ├── test/
│   └── bashdb
├── src/
│   ├── bashDebug.ts
│   ├── bashTerminal.ts
│   ├── debugSession.ts
│   ├── extension.ts
│   └── utils.ts
├── .gitignore
├── .vscodeignore
├── CHANGELOG.md
├── LICENSE
├── package.json
├── README.md
└── tsconfig.json

目录结构介绍

• .github/: 包含GitHub相关的配置文件，如Issue模板。
• .vscode/: 包含VSCode的配置文件，如调试配置文件launch.json。
• assets/: 包含项目所需的静态资源，如图片。
• bashdb/: 包含bashdb调试器的核心文件，包括库文件和测试文件。
• src/: 包含项目的源代码，主要由TypeScript文件组成。
• .gitignore: 指定Git忽略的文件和目录。
• .vscodeignore: 指定VSCode忽略的文件和目录。
• CHANGELOG.md: 记录项目的更新日志。
• LICENSE: 项目的开源许可证。
• package.json: 项目的依赖管理文件。
• README.md: 项目的介绍和使用说明。
• tsconfig.json: TypeScript的配置文件。

2. 项目的启动文件介绍

src/extension.ts

这是项目的入口文件，负责初始化扩展并注册调试器。主要功能包括：

• 注册调试适配器。
• 配置调试器的启动参数。
• 处理调试会话的生命周期。

src/bashDebug.ts

该文件定义了调试器的主要逻辑，包括：

• 启动和停止调试会话。
• 处理调试命令和事件。
• 与bashdb进行交互。

3. 项目的配置文件介绍

package.json

这是Node.js项目的配置文件，包含项目的元数据和依赖项。主要内容包括：

• name: 项目名称。
• version: 项目版本。
• publisher: 发布者信息。
• engines: 项目所需的运行环境。
• activationEvents: 扩展的激活事件。
• contributes: 扩展的贡献点，如调试器配置。

.vscode/launch.json

这是VSCode的调试配置文件，用于配置调试会话。主要内容包括：

• configurations: 定义调试配置，如调试类型、请求类型、工作目录、程序路径等。
• terminalKind: 指定终端类型，如integrated或external。

示例配置：

{
    "version": "0.2.0",
    "configurations": [
        {
            "type": "bashdb",
            "request": "launch",
            "name": "Bash Debug",
            "cwd": "${workspaceFolder}",
            "program": "${file}",
            "terminalKind": "integrated"
        }
    ]
}

通过以上配置，可以在VSCode中启动并调试Bash脚本。

vscode-bash-debugBash shell debugger extension for VSCode (based on bashdb)项目地址:https://gitcode.com/gh_mirrors/vs/vscode-bash-debug