CBP 构建管理器
一个用于管理和构建 Code::Blocks 项目（.cbp 文件）的 VS Code 扩展，使用 cbp2clang 和自定义构建脚本。
功能特性
- 项目扫描：自动查找工作区中的所有 .cbp 文件
- 双视图管理：
- 构建队列：显示已选择的项目，支持拖放排序和复选框选择
- 项目资源库：按文件夹层级显示可用项目，自动隐藏已在队列中的项目
- 拖放操作：在构建队列中拖动来控制构建顺序
- cbp2clangd 版本检查：自动检查 cbp2clangd 版本，确保使用兼容版本
- Ninja 路径配置：支持自动检查和更新 Ninja 路径，兼容旧版本设置
- 可自定义命令：配置 cbp2clang 路径和构建脚本
- 构建输出：使用 Pseudoterminal 在终端中显示日志，支持 ANSI 控制符和彩色输出
- 重新编译功能：先清理后构建，提高开发效率
- 单独清理功能：可单独运行清理命令，方便管理构建文件
安装方法
方法 1：从 VSIX 包安装
- 下载最新的
cbp-build-manager-0.1.2.vsix 文件
- 打开 VS Code
- 按
Ctrl+Shift+X 打开扩展面板
- 点击右上角的
... 菜单
- 选择 从 VSIX 安装...
- 浏览并选择下载的 VSIX 文件
- 重启 VS Code 以激活扩展
方法 2：开发模式
- 克隆此仓库
- 在 VS Code 中打开文件夹
- 运行
pnpm install 安装依赖
- 运行
pnpm run compile 编译扩展
- 按
F5 在开发模式下运行扩展
配置选项
打开 VS Code 设置 (Ctrl+,) 并搜索 CBP Build Manager 来配置以下设置：
| 设置项 |
默认值 |
描述 |
cbpBuildManager.cbp2clangPath |
cbp2clang |
cbp2clang 可执行文件的路径，可从 GitHub 下载 |
cbpBuildManager.convertCommand |
{cbp2clang} {cbpFile} {compileCommands} -l ld |
转换命令的模板 |
cbpBuildManager.buildCommand |
./build.bat |
运行构建脚本的命令 |
cbpBuildManager.ninjaPath |
"" |
ninja 可执行文件的路径，支持自动检查和更新，兼容旧版本文件夹路径设置 |
cbpBuildManager.noHeaderInsertion |
true |
禁止 clangd 在补全代码时插入头文件（需要 clangd v21 以上版本，否则 .clangd 文件会出现 lint 错误：Unknown Completion key 'HeaderInsertion'） |
使用指南
1. 打开工作区
在 VS Code 中打开包含 Code::Blocks 项目（.cbp 文件）的文件夹。
2. 访问扩展
点击活动栏（侧边栏）中的 CBP Builder 图标打开 CBP Build Manager 视图。
3. 扫描项目
点击 刷新 按钮（🔄）扫描工作区中的 .cbp 文件。
4. 管理项目
添加项目到构建队列
- 在下方的项目资源库视图中浏览可用项目
- 选择要构建的项目（支持多选）
- 点击 添加到构建 按钮（➕）将项目添加到上方的构建队列
配置构建队列
- 复选框：点击项目前的复选框选择要构建的项目
- 拖放：在构建队列中拖动来更改构建顺序
- 删除项目：右键点击项目，选择从编译列表移除选项
5. 构建项目
点击 构建 按钮（▶️）开始按指定顺序构建构建队列中勾选的项目。
6. 重新编译项目
点击 重新编译 按钮（🔄）开始按指定顺序重新编译构建队列中勾选的项目：
- 首先运行
ninja -t clean 清理构建文件
- 然后执行正常的构建流程
7. 清理项目
点击 清理 按钮（🗑️）开始按指定顺序清理构建队列中勾选的项目：
- 仅运行
ninja -t clean 清理构建文件
- 不执行后续的构建流程
构建流程
当你点击构建按钮时，扩展会执行以下步骤：
- 读取配置：获取 cbp2clang 和命令的设置
- 检查 cbp2clangd 版本：确保 cbp2clangd 版本兼容（最小要求：v1.2.7）
- 生成命令：为构建队列中勾选的每个项目创建转换命令，使用 VSCode 工作区路径作为 compile_commands.json 输出路径
- 运行转换：执行 cbp2clang 生成 compile_commands.json，用于 clangd 插件索引项目
- 执行构建脚本：运行配置的构建脚本（默认：./build.bat）
- 显示输出：在输出面板和终端中显示日志
故障排除
构建脚本问题
- 检查脚本存在性：确保 build.bat 存在于项目目录中
- 验证权限：确保构建脚本具有执行权限
- 检查 cbp2clang 路径：确保 cbp2clang 在系统 PATH 中或配置正确
拖放功能不工作
- 检查 VS Code 版本：确保使用的是 VS Code 1.64.0 或更高版本（支持 TreeView 拖放）
- 禁用冲突扩展：暂时禁用其他扩展以检查冲突
- 重启 VS Code：有时重启可以解决 UI 问题
开发指南
前提条件
- Node.js 18.x 或更高版本：用于运行 JavaScript/TypeScript 代码
- pnpm 包管理器：用于管理项目依赖
- VS Code 1.64.0 或更高版本：用于开发和测试扩展
- Git：用于版本控制
编译环境准备
克隆仓库
git clone https://github.com/greedyhao/cbp-build-manager.git
cd cbp-build-manager
安装项目依赖
pnpm install
安装 VSCE 工具（用于生成 VSIX 包）
pnpm add -D @vscode/vsce
编译扩展
开发模式编译
单次编译：
pnpm run compile
该命令会执行：
- 类型检查 (
tsc --noEmit)
- 代码 lint 检查 (
eslint src)
- 使用 esbuild 编译扩展 (
node esbuild.js)
监听模式编译（开发时推荐）：
pnpm run watch
该命令会：
- 启动 esbuild 监听模式，自动编译代码变更
- 启动 TypeScript 类型检查监听
生产模式编译
- 生产编译：
pnpm run package
该命令会执行：
- 类型检查 (
tsc --noEmit)
- 代码 lint 检查 (
eslint src)
- 使用 esbuild 生产模式编译（压缩代码，无 sourcemap）
打包 VSIX 扩展包
确保生产编译完成
pnpm run package
生成 VSIX 包
pnpm run vsix
输出文件
- 生成的 VSIX 文件位于项目根目录：
cbp-build-manager-0.1.2.vsix
开发测试
运行测试：
pnpm run test
在 VS Code 中调试：
- 按
F5 或点击 "Run and Debug" 面板中的 "Run Extension" 按钮
- VS Code 会启动一个新的实例，加载你的扩展
- 可以在原 VS Code 实例中设置断点、查看日志
项目结构
cbp-build-manager/
├── src/ # 源代码目录
│ ├── extension.ts # 主扩展代码
│ └── test/ # 测试文件
├── dist/ # 编译输出目录
│ └── extension.js # 编译后的扩展代码
├── resources/ # 资源文件
│ └── icon.svg # 扩展图标
├── package.json # 扩展配置和依赖
├── tsconfig.json # TypeScript 配置
├── esbuild.js # esbuild 构建脚本
├── .vscodeignore # VSIX 打包忽略文件配置
└── README.md # 项目说明文档
贡献指南
- Fork 此仓库
- 创建功能分支
- 进行更改
- 运行测试确保没有回归问题
- 提交拉取请求
许可证
MIT 许可证 - 详见 LICENSE 文件
支持
如果遇到问题，请：
- 查看上面的故障排除部分
- 查看输出面板中的调试日志
- 在仓库中搜索现有问题
- 创建新问题并提供详细信息
更新日志
详细的更新日志请查看 CHANGELOG.md 文件。
享受使用 CBP Build Manager 构建 Code::Blocks 项目！🚀
