# wps-vba-sync

**Repository Path**: graper/wps-vba-sync

## Basic Information

- **Project Name**: wps-vba-sync
- **Description**: **WPS/Excel VBA模块双向同步工具 for VSCode/Trae**

支持 WPS表格 和 Microsoft Excel 的 VBA 模块导出、编辑和导入，**保存即自动同步**。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-16
- **Last Updated**: 2026-05-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# WPS VBA Sync

**WPS/Excel VBA模块双向同步工具 for VSCode/Trae**

支持 WPS表格 和 Microsoft Excel 的 VBA 模块导出、编辑和导入，**保存即自动同步**。

## 功能特性

| 功能 | 说明 |
|------|------|
| 📤 导出VBA模块 | 从WPS/Excel导出所有VBA模块到文件系统 |
| 📥 导入VBA模块 | 将编辑后的VBA模块导入回WPS/Excel |
| 🔄 **双向同步** | 同时执行导出和导入操作 |
| 👁️ **保存即同步** | 文件监控 - 保存 `.bas/.cls/.frm` 文件自动同步到VBA |
| 📁 灵活配置 | 可配置导出文件夹、同步延迟等参数 |

## 系统要求

- **操作系统**: Windows 10/11
- **Python**: 3.8+
- **WPS表格** 或 **Microsoft Excel** (需要VBA支持)
- **VSCode** 或 **Trae IDE**

## 快速开始

### 1. 安装依赖

```bash
pip install -r requirements.txt
```

### 2. 安装扩展

在 VSCode/Trae 中:
1. 打开扩展视图 (`Ctrl+Shift+X`)
2. 点击「从VSIX安装...」
3. 选择编译好的 `extension.vsix`

### 3. 配置

在 VSCode/Trae 设置中搜索 `wpsVbaSync`:

| 配置项 | 默认值 | 说明 |
|--------|--------|------|
| `exportFolder` | `vba` | VBA模块导出文件夹 |
| `targetApp` | `wps` | 目标应用: `wps` 或 `excel` |
| `autoSync` | `true` | 启用保存即自动同步 |
| `watchDelay` | `500` | 文件监控延迟(毫秒) |

### 4. 使用

1. 打开 WPS表格 或 Excel，打开包含VBA的工作簿
2. 在 VSCode/Trae 中按 `Ctrl+Shift+P`，执行 **导出所有VBA模块**
3. 在 `vba` 文件夹中编辑 VBA 代码
4. **保存文件时自动同步到WPS/Excel**！

或者手动同步:
- `Ctrl+Shift+P` → **双向同步全部** - 同时导出和导入

## 命令列表

| 命令 | 说明 |
|------|------|
| `导出所有VBA模块` | 导出WPS/Excel中的所有VBA模块 |
| `导入VBA模块` | 导入单个VBA模块文件 |
| `设置导出文件夹` | 更改导出目录 |
| `双向同步全部` | 同时执行导出和导入 |
| `启用自动同步` | 开启保存即同步 |
| `禁用自动同步` | 关闭自动同步 |

## 项目结构

```
wps-vba-sync/
├── pywpsvba/              # Python同步核心
│   ├── __init__.py
│   ├── vba_sync.py        # VBA同步逻辑
│   ├── wps_com.py         # WPS COM接口
│   ├── excel_com.py       # Excel COM接口
│   └── cli.py             # 命令行工具
├── src/
│   └── extension.ts       # VSCode/Trae扩展主代码
├── locales/               # 语言文件
│   └── zh.json
├── package.json           # 扩展配置
└── requirements.txt       # Python依赖
```

## Python CLI 用法

```bash
# 导出所有模块
python pywpsvba/cli.py export -o vba -a wps

# 导入模块
python pywpsvba/cli.py import -f Module1.bas -a wps

# 列出模块
python pywpsvba/cli.py list -a wps

# 双向同步
python pywpsvba/cli.py sync -d vba -a wps --to-vba --to-file
```

## 注意事项

⚠️ **不要编辑导出文件的属性行**

不要更改 `VERSION`、`Begin … End`、`Object = …` 或 `Attribute VB_*` 等属性，否则可能导致导入失败。

⚠️ **无法添加新模块**

此工具仅支持替换现有模块。如需创建新模块，请在WPS/Excel中手动添加。

⚠️ **请备份文件**

操作VBA前建议备份工作簿文件。

## 许可证

MIT License