GitSnapshot（Git 快照）

English | 中文

“GitSnapshot / Git 快照” 是面向嘉立创 EDA 专业版（JLCEDA Pro / EasyEDA Pro）的工程版本快照管理扩展。它为你当前的工程建立版本快照，逐个捕获工程内全部原理图页与 PCB 的内容，并支持通过 Git 提交与推送到远程仓库。

• 源码仓库：https://github.com/chenjiajungithub/easyeda-GitSnapshot

插件展示

功能特性

• 一键创建整工程快照：无需逐页切换，自动遍历当前工程的所有原理图页与 PCB，逐个保存其内容。
• 双快照逐文档对比：任选两个快照，查看每个原理图/PCB 的内容差异。
• 内置 Git 支持：git add、git commit、git push 一键到本地仓库并推送远程。
• 远程仓库配置：支持空远程仓库与已含历史的远程仓库；本地与远程历史分叉时自动以远程为基础重新提交，保证推送成功。
• 工程信息状态栏：实时显示当前工程名称与快照数量。

前置依赖

• 嘉立创 EDA 专业版（JLCEDA Pro / EasyEDA Pro），建议版本 3.2.0 及以上。
• 本扩展：请优先在嘉立创官方扩展广场搜索 “Git 快照” 安装；也可以使用本仓库发布包（.eext）手动安装。

嘉立创 EDA 设置

首次使用前，请确保 EDA 允许扩展调用工程读写与网络接口：

1. 打开 顶栏菜单 → 设置 / Settings。
2. 找到 扩展 / Extension 或 开发者选项 / Developer 相关设置，开启**“允许外部扩展交互 / 允许扩展访问工程 API”**一类的外部交互权限。
3. 如 EDA 提示扩展需授予权限（如读取工程、下载工程），请点击允许 / 授权。

说明：若权限未开启，插件可能无法读取工程文档或创建快照。请在开启权限后关闭并重新打开工程。

安装步骤

按顺序从零开始安装：

1. 在嘉立创 EDA 专业版中打开扩展相关入口：顶部菜单 → 扩展 / 插件 → 扩展市场 / Manage Extensions。
2. 在扩展市场搜索 “Git 快照 / GitSnapshot”，点击安装（Install）；或使用发布包本地安装：
   • 下载本仓库 build/dist/easyeda-git_v1.0.0.eext。
   • 在扩展管理界面选择 导入 / Import / Load，选中上面下载的 .eext 文件。
3. 安装完成后，在 扩展管理 中确认 Git 快照 已启用（Enable）。
4. 打开一个工程，确认权限已按要求开启（见上一节）。
5. 若扩展已有旧版本，请先卸载旧版再安装新版（面板 HTML 会在安装时缓存到 EDA，旧版缓存可能导致新界面不生效）。

使用方法

启动

打开任意工程，点击顶部菜单 “打开 Git 快照”（位于首页 / 原理图 / PCB 页头菜单下），即可打开 Git 快照面板。

主要操作

• 创建快照：在面板顶部输入标题与描述，点击“创建快照”。扩展会自动遍历当前工程的所有原理图页与 PCB，逐个截取内容并保存为一个版本快照。
• 对比：点击“对比”，在下拉框中选择两个不同快照，可逐文档查看内容差异。
• git add：把当前快照文件暂存到内置的本地 Git 仓库。
• git commit：将暂存内容提交为一次本地提交。
• git push：将本地提交推送到远程仓库（需先在“设置”中填写远程地址）。
• 设置（⚙）：配置远程仓库地址、分支、认证信息；以及 AI 密钥占位。

典型场景

• 版本回退与审阅：每次改动电路前创建一个快照，随时对比不同阶段的原理图/PCB，确认改动内容。
• 团队协作：在团队仓库开设分支，把工程快照推送到远程，供他人拉取审阅或存档。
• 备份存档：按里程碑定期创建快照并提交推送，形成工程的完整历史记录。

常见问题（FAQ）

• 点击“打开 Git 快照”无反应 / 面板打不开
  • 确认扩展已启用；若为旧版本安装，请卸载后重新安装（见安装步骤第 5 条）。
• 创建快照没有捕获到文档 / 内容为空
  • 检查“嘉立创 EDA 设置”一节中的外部交互权限是否已开启，并确保当前已打开工程。
• git push 提示认证失败或连不上远程
  • 在“设置”中确认远程仓库地址、用户名/访问令牌是否正确；私有仓库需填写凭据。
• git push 提示历史分叉
  • 扩展会自动以远程为基础重新提交（保证推送成功），无需手动处理冲突。
• 快照对比显示所有文档都“已修改”
  • 这是初次跨版本正常的物理差异提示，可结合具体内容确认是否真正的设计改动。

开发与构建（可选）

仅当你想从源码构建时才需要以下步骤：

npm install
npm install --prefix iframe
npm run compile    # 构建主进程 bundle 与 iframe 面板
npm run package    # 打包 .eext 发布包到 build/dist/
npm test           # 运行测试

许可证

Apache-2.0