# CAABuildTool

**Repository Path**: Karze/CAABuildTool

## Basic Information

- **Project Name**: CAABuildTool
- **Description**: 用于Catia CAA开发的vscode插件
- **Primary Language**: JavaScript
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-06-25
- **Last Updated**: 2026-02-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: CAA, CATIA, VSCode

## README

# CAA Build Tool

## 项目概述

CAA Build Tool 是一个 Visual Studio Code 扩展，专为 Catia CAA 开发人员设计，提供简化的构建、编译和运行工作流程。该扩展通过直观的界面和强大的命令功能，帮助开发人员更高效地管理和执行 CAA 相关任务。当前只支持CATIA V5版本。

## 主要特性

- **快速编译和运行**：一键执行编译和运行操作
- **单独编译功能**：只执行编译步骤而不运行
- **单独执行程序**：直接运行已编译的程序
- **创建/更新运行时资源**：自动处理运行时视图资源
- **框架管理**：轻松添加新框架
- **模块创建**：通过右键菜单快速创建新模块
- **自定义配置**：灵活设置工具路径、命令参数等选项
- **实时输出日志**：执行过程中实时显示输出信息

## 安装方法

### 从 VSIX 文件安装

1. 下载扩展的 VSIX 文件（位于 `release` 目录）
2. 在 VS Code 中，按下 `Ctrl+Shift+P`（或 `Cmd+Shift+P` on macOS）
3. 输入 "Extensions: Install from VSIX..."
4. 选择下载的 VSIX 文件完成安装

## 打包流程

如果您需要自行打包扩展，请按照以下步骤操作：

1. **安装 Node.js 和 npm**
   - 确保您的系统已安装 Node.js 和 npm
   - 可以从 [Node.js 官网](https://nodejs.org/) 下载并安装

2. **安装 VS Code Extensions CLI**
   ```bash
   npm install -g @vscode/vsce
   ```

3. **准备打包环境**
   - 确保项目中包含 `package.json` 和 `package-lock.json` 文件
   - 如果没有 `package-lock.json`，可以运行 `npm install` 生成

4. **构建 VSIX 文件**
   - 进入扩展项目的根目录（`caabuildtool` 目录）
   - 运行以下命令：
   ```bash
   vsce package
   ```

5. **获取生成的 VSIX 文件**
   - 打包成功后，会在当前目录生成 `.vsix` 文件
   - 可以将该文件复制到 `release` 目录以便他人使用

## 使用说明

### 基本使用流程

1. 安装扩展后，在 VS Code 左侧活动栏中点击 CAA Build Tool 图标
2. 在打开的视图中，您可以看到以下按钮：
   - Build and Run（编译并运行）
   - Build（编译）
   - Exec（执行程序）
   - CreateRuntimeView（创建/更新运行时资源）
   - Add Framework（添加框架）

3. 点击相应按钮执行操作

### 创建模块

1. 在文件资源管理器中，右键点击要创建模块的文件夹
2. 选择 "CAATool:Create Module"
3. 输入模块名称，系统将自动创建模块文件夹结构和必要文件

### 添加框架

1. 在 CAA Build Tool 视图中点击 "Add Framework" 按钮
2. 输入框架名称并确认
3. 扩展将自动执行创建框架的操作

## 配置选项

扩展提供以下配置选项，可通过 VS Code 设置界面访问：

1. **toolsRootDirectory**
   - 类型：字符串
   - 默认值："E:\Program Files\Dassault Systemes\B18"
   - 描述：Catia 根目录路径

2. **cmd**
   - 类型：字符串
   - 默认值："cnext"
   - 描述：要运行的命令（模块名称）

3. **cmdParams**
   - 类型：字符串
   - 默认值：""
   - 描述：命令参数

4. **isDebug**
   - 类型：布尔值
   - 默认值：false
   - 描述：调试模式开关

5. **raderBinPath**
   - 类型：字符串
   - 默认值：""
   - 描述：RADER Bin 路径

6. **raderCommandPath**
   - 类型：字符串
   - 默认值：""
   - 描述：RADER Command 路径

7. **showConsole**
   - 类型：布尔值
   - 默认值：false
   - 描述：是否显示控制台输出

## 命令列表

### 视图命令

- **编译并运行** (`caabuildtool.buildAndRun`)：编译项目并运行程序
- **编译** (`caabuildtool.build`)：仅编译项目
- **执行程序** (`caabuildtool.exec`)：运行已编译的程序
- **创建/更新运行时资源** (`caabuildtool.createRuntimeView`)：更新运行时资源
- **Add Framework** (`caabuildtool.showAddFrameworkDialog`)：添加新框架
- **Open CAA Build Tool Settings** (`caabuildtool.openSettings`)：打开扩展配置页面

### 上下文菜单命令

- **CAATool:Create Module** (`caabuildtool.createModule`)：在当前目录创建新模块

## 输出信息

所有命令的执行结果都会显示在 "CAA Build Tool" 输出通道中，您可以通过以下方式查看：

1. 按下 `Ctrl+Shift+U`（或 `Cmd+Shift+U` on macOS）
2. 在下拉菜单中选择 "CAA Build Tool"

## 版本历史

当前版本：0.0.16

## 注意事项

- 请确保已正确设置 Catia 根目录路径
- 对于自定义命令，请在配置中设置正确的命令名称和参数
- 在调试模式下，扩展将使用 debug.bat 而不是 run.bat
- 创建模块功能将自动生成基本的 Imakefile.mk 文件结构

## 问题反馈

如有任何问题或建议，请提交至项目仓库或联系开发团队。