@windypro-rourou/dsh-eda 0.1.0 → 0.1.2

package/skill/INDEX.md

@@ -0,0 +1,193 @@
+# 官方 EasyEDA Skill 知识库导航
+
+本目录为官方 easyeda-api-skill 文档的 vendored 拷贝（含 SKILL.md 总纲、官方 README、format/ 文档格式、guide/ 教程、references/ 参考文档）。agent 通过 `eda_skill_read` 查阅：`doc` 参数填本文件内的相对路径，如 `references/classes/SCH_PrimitiveComponent.md`。
+
+## 入口
+
+| 文件 | 内容 |
+|---|---|
+| SKILL.md | 官方总纲（环境/坐标系/常见错误/示例） |
+| README.official.md / README.zh-Hans.official.md | 官方说明（英文/中文） |
+| guide/ | 教程（使用扩展/如何开始/市场/国际化等） |
+| user-guide/ | 用户指南 |
+| format/ | 官方文档格式（schematic/pcb/project 各字段） |
+
+## 按任务快速定位
+
+| 任务 | 推荐文档 |
+|---|---|
+| 画原理图导线/元件 | references/classes/SCH_PrimitiveWire.md、SCH_PrimitiveComponent.md、SCH_Document.md |
+| 网络标志/端口 | SCH_PrimitiveComponent.md（createNetFlag/createNetPort） |
+| DRC | SCH_Drc.md、PCB_Drc.md |
+| 网表/BOM | SCH_ManufactureData.md、SCH_Netlist.md、PCB_ManufactureData.md |
+| PCB 元件/过孔/走线 | PCB_PrimitiveComponent.md、PCB_PrimitiveVia.md、PCB_PrimitiveLine.md、PCB_Document.md |
+| 工程/文档管理 | DMT_Project.md、DMT_EditorControl.md、DMT_Schematic.md、DMT_Pcb.md |
+| 搜索器件 | LIB_Device.md、LIB_LibrariesList.md |
+| 画板截图 | DMT_EditorControl.md（getCurrentRenderedAreaImage） |
+| 文档导出/本地文件 | SYS_FileManager.md、SYS_FileSystem.md |
+
+## references/classes 类索引（127 个）
+
+### SCH_*（21 个）
+
+- SCH_Document
+- SCH_Drc
+- SCH_Event
+- SCH_ManufactureData
+- SCH_Net
+- SCH_Netlist
+- SCH_Primitive
+- SCH_PrimitiveArc
+- SCH_PrimitiveAttribute
+- SCH_PrimitiveBus
+- SCH_PrimitiveCircle
+- SCH_PrimitiveComponent
+- SCH_PrimitiveObject
+- SCH_PrimitivePin
+- SCH_PrimitivePolygon
+- SCH_PrimitiveRectangle
+- SCH_PrimitiveText
+- SCH_PrimitiveWire
+- SCH_SelectControl
+- SCH_SimulationEngine
+- SCH_Utils
+
+### PCB_*（25 个）
+
+- PCB_Document
+- PCB_Drc
+- PCB_Event
+- PCB_Layer
+- PCB_ManufactureData
+- PCB_MathPolygon
+- PCB_Net
+- PCB_Primitive
+- PCB_PrimitiveArc
+- PCB_PrimitiveAttribute
+- PCB_PrimitiveComponent
+- PCB_PrimitiveDimension
+- PCB_PrimitiveFill
+- PCB_PrimitiveImage
+- PCB_PrimitiveLine
+- PCB_PrimitiveObject
+- PCB_PrimitivePad
+- PCB_PrimitivePolyline
+- PCB_PrimitivePour
+- PCB_PrimitivePoured
+- PCB_PrimitiveRegion
+- PCB_PrimitiveString
+- PCB_PrimitiveVia
+- PCB_RayTracerEngine
+- PCB_SelectControl
+
+### IPCB_*/ISCH_*（31 个）
+
+- IPCB_ComplexPolygon
+- IPCB_Polygon
+- IPCB_PrimitiveArc
+- IPCB_PrimitiveAttribute
+- IPCB_PrimitiveComponent
+- IPCB_PrimitiveComponentPad
+- IPCB_PrimitiveDimension
+- IPCB_PrimitiveFill
+- IPCB_PrimitiveImage
+- IPCB_PrimitiveLine
+- IPCB_PrimitiveObject
+- IPCB_PrimitivePad
+- IPCB_PrimitivePolyline
+- IPCB_PrimitivePour
+- IPCB_PrimitivePoured
+- IPCB_PrimitiveRegion
+- IPCB_PrimitiveString
+- IPCB_PrimitiveVia
+- ISCH_PrimitiveArc
+- ISCH_PrimitiveAttribute
+- ISCH_PrimitiveBus
+- ISCH_PrimitiveCbbSymbolComponent
+- ISCH_PrimitiveCircle
+- ISCH_PrimitiveComponent
+- ISCH_PrimitiveComponentPin
+- ISCH_PrimitiveObject
+- ISCH_PrimitivePin
+- ISCH_PrimitivePolygon
+- ISCH_PrimitiveRectangle
+- ISCH_PrimitiveText
+- ISCH_PrimitiveWire
+
+### DMT_*（11 个）
+
+- DMT_Board
+- DMT_EditorControl
+- DMT_Event
+- DMT_Folder
+- DMT_Panel
+- DMT_Pcb
+- DMT_Project
+- DMT_Schematic
+- DMT_SelectControl
+- DMT_Team
+- DMT_Workspace
+
+### LIB_*（10 个）
+
+- LIB_3DModel
+- LIB_Cbb
+- LIB_Classification
+- LIB_Device
+- LIB_Footprint
+- LIB_LibrariesList
+- LIB_PanelLibrary
+- LIB_SelectControl
+- LIB_SimulationModel
+- LIB_Symbol
+
+### SYS_*（27 个）
+
+- SYS_ClientUrl
+- SYS_Dialog
+- SYS_Environment
+- SYS_FileManager
+- SYS_FileSystem
+- SYS_FontManager
+- SYS_FormatConversion
+- SYS_HeaderMenu
+- SYS_I18n
+- SYS_IFrame
+- SYS_LoadingAndProgressBar
+- SYS_Log
+- SYS_Math
+- SYS_Message
+- SYS_MessageBox
+- SYS_MessageBus
+- SYS_PanelControl
+- SYS_RightClickMenu
+- SYS_Setting
+- SYS_ShortcutKey
+- SYS_Storage
+- SYS_Timer
+- SYS_ToastMessage
+- SYS_Tool
+- SYS_Unit
+- SYS_WebSocket
+- SYS_Window
+
+### PNL_*（1 个）
+
+- PNL_Document
+
+### EDA（1 个）
+
+- EDA
+
+## 其它参考
+
+### references/enums
+> EDMT_EditorDocumentType、EDMT_EditorSplitScreenDirection、EDMT_EditorTabEventType、EDMT_IndicatorMarkerType、EDMT_ItemType、EDMT_ProjectCollaborationMode、ELIB_DeviceJlcLibraryCategory、ELIB_LibraryType、ELIB_PreviewType、ELIB_SimulationModelType、ELIB_SymbolType、EPCB_AutoRoutingCornerStyle、EPCB_AutoRoutingExistingPrimitiveMode、EPCB_AutoRoutingOptimization、EPCB_DocumentCanvasUpdateCalculationActiveStatus、EPCB_DocumentRatlineCalculatingActiveStatus、EPCB_InactiveLayerDisplayMode、EPCB_LayerColorConfiguration、EPCB_LayerId、EPCB_LayerStatus、EPCB_LayerType、EPCB_MouseEventType、EPCB_NetEventType、EPCB_PcbPlateType、EPCB_PdfOutputMethod、EPCB_PrimitiveArcInteractiveMode、EPCB_PrimitiveDimensionType、EPCB_PrimitiveEventType、EPCB_PrimitiveFillMode、EPCB_PrimitivePadHeatWeldingConnectionMethod、EPCB_PrimitivePadHoleType、EPCB_PrimitivePadShapeType、EPCB_PrimitivePadType、EPCB_PrimitivePourFillMethod、EPCB_PrimitiveRegionRuleType、EPCB_PrimitiveStringAlignMode、EPCB_PrimitiveType、EPCB_PrimitiveViaType、ESCH_DynamicSimulationEnginePullEventType、ESCH_DynamicSimulationEnginePushEventType、ESCH_ExportDocumentFileType、ESCH_MouseEventType、ESCH_PrimitiveComponentType、ESCH_PrimitiveEventType、ESCH_PrimitiveFillStyle、ESCH_PrimitiveLineType、ESCH_PrimitivePinShape、ESCH_PrimitivePinType、ESCH_PrimitiveTextAlignMode、ESCH_PrimitiveType、ESCH_SimulationNetlistType、ESCH_SpiceSimulationEnginePullEventType、ESCH_SpiceSimulationEnginePushEventType、ESYS_BottomPanelTab、ESYS_HeaderMenuEnvironment、ESYS_ImportProjectBoardOutlineSource、ESYS_ImportProjectImportOption、ESYS_ImportProjectSchematicObjectStyle、ESYS_ImportProjectViaSolderMaskExpansion、ESYS_LeftPanelTab、ESYS_LogType、ESYS_NetlistType、ESYS_RightPanelTab、ESYS_ShortcutKeyEffectiveEditorRange、ESYS_ShortcutKeyEffectiveEditorScene、ESYS_StartPageQuickStartItem、ESYS_Theme、ESYS_ToastMessageType、ESYS_Unit、ESYS_WindowEventType、ESYS_WindowOpenTarget、NetportDeviceName、SchToolBarDeviceName
+
+### references/types
+> ISYS_LanguageKeyValuePairs、TPCB_LayerTypesOfInnerLayer、TPCB_LayersInTheSelectable、TPCB_LayersOfComponent、TPCB_LayersOfCopper、TPCB_LayersOfCustom、TPCB_LayersOfDimension、TPCB_LayersOfFill、TPCB_LayersOfImage、TPCB_LayersOfInner、TPCB_LayersOfLine、TPCB_LayersOfObject、TPCB_LayersOfPad、TPCB_LayersOfRegion、TPCB_NumberOfCopperLayers、TPCB_PolygonSourceArray、TPCB_PrimitiveDimensionCoordinateSet、TPCB_PrimitivePadHole、TPCB_PrimitivePadShape、TPCB_PrimitiveSpecialPadShape、TSYS_MathPolygonGroup、TSYS_MathPolygonInput、TSYS_PcbComparisonErrorCode、TSYS_ShortcutKeys
+
+### references/interfaces
+> BoardProps、ButtonProps、CheckBoxProps、ComponentPropsMap、DialogProps、FlexItemProps、FlexProps、GridItemProps、GridProps、IDMT_BoardItem、IDMT_BriefProjectItem、IDMT_EditorDocumentItem、IDMT_EditorSplitScreenItem、IDMT_EditorTabItem、IDMT_FolderItem、IDMT_IndicatorMarkerShape、IDMT_PanelItem、IDMT_PcbItem、IDMT_ProjectItem、IDMT_SchematicItem、IDMT_SchematicPageItem、IDMT_TeamItem、IDMT_WorkspaceItem、IDesignPortal、ILIB_3DModelItem、ILIB_3DModelSearchItem、ILIB_CbbItem、ILIB_CbbSearchItem、ILIB_ClassificationIndex、ILIB_DeviceAssociationItem、ILIB_DeviceExtendPropertyItem、ILIB_DeviceItem、ILIB_DevicePropertiesForSearch、ILIB_DeviceSearchItem、ILIB_ExtendLibrary3DModelFunctions、ILIB_ExtendLibraryCbbFunctions、ILIB_ExtendLibraryClassificationIndex、ILIB_ExtendLibraryDeviceFunctions、ILIB_ExtendLibraryFootprintFunctions、ILIB_ExtendLibraryFunctions、ILIB_ExtendLibraryItem、ILIB_ExtendLibraryItemIndex、ILIB_ExtendLibrarySearchProperty、ILIB_ExtendLibrarySearchResult、ILIB_ExtendLibrarySearchResultDataLine、ILIB_ExtendLibrarySymbolFunctions、ILIB_ExtendLibraryUserIndex、ILIB_FootprintItem、ILIB_FootprintPropertiesForSearch、ILIB_FootprintSearchItem、ILIB_LibraryInfo、ILIB_LibraryItem、ILIB_PanelLibraryItem、ILIB_PanelLibrarySearchItem、ILIB_SimulationModelItem、ILIB_SimulationModelSearchItem、ILIB_SymbolItem、ILIB_SymbolPropertiesForSearch、ILIB_SymbolSearchItem、IPCB_AutoLayoutResult、IPCB_AutoRoutingProps、IPCB_AutoRoutingResult、IPCB_BomPropertiesTableColumns、IPCB_DifferentialPairItem、IPCB_DiscretizeOptions、IPCB_DiscretizedPoint、IPCB_EqualLengthNetGroupItem、IPCB_LayerItem、IPCB_NetClassItem、IPCB_NetInfo、IPCB_PadPairGroupItem、IPCB_PadPairMinWireLengthItem、IPCB_PhysicalStackingConfiguration、IPCB_Primitive、IPCB_PrimitiveAPI、IPCB_PrimitivePadHeatWelding、IPCB_PrimitivePouredPourFill、IPCB_PrimitiveSolderMaskAndPasteMaskExpansion、IPCB_SubstratePhysicalProperties、IRawNet、IRawPureSchematic、IRawSchematic、IRawWire、ISCH_DrcError、ISCH_DrcErrorPrimitive、ISCH_ExportPngResolution、ISCH_NetInfo、ISCH_Primitive、ISCH_PrimitiveAPI、ISCH_ProjectNetInfo、ISCH_WireInfo、ISYS_FileSystemFileList、ISYS_HeaderMenuSub1MenuItem、ISYS_HeaderMenuSub2MenuItem、ISYS_HeaderMenuTopMenuItem、ISYS_HeaderMenus、ISYS_LogLine、ISYS_MathBBox、ISYS_MathPoint、ISYS_MathPolygonWithHoles、ISYS_MessageBusTask、ISYS_MultilingualLanguagesData、ISYS_PcbComparisonResponse、ISYS_RightClickMenuItem、ISYS_ShortcutKeyData、ISYS_ShortcutKeyDataWithCallFn、ISYS_ShortcutKeyDataWithUserDefinedShortcutKey、ISYS_WindowEventListenerRemovableObject、IconProps、ImageProps、InputProps、ListChildren、ListProps、ModalProps、RadioGroupProps、RadioItem、ScrollerProps、SelectListItem、SelectProps、SlotProps、StyleProps、TextAreaProps、TextProps
+
+> 查阅方式：`eda_skill_read { "doc": "references/classes/SCH_PrimitiveComponent.md" }`

package/skill/README.official.md

@@ -0,0 +1,125 @@
+[English](#) | [简体中文](./README.zh-Hans.md)
+
+# EasyEDA API Skill
+
+An EasyEDA Pro API skill package for AI coding tools such as Claude Code, OpenCode, QwenCode, and any other tool that supports the [Agent Skills](https://agentskills.io/) standard.
+
+This skill supports both online debugging of EasyEDA Pro through AI and extension development for EasyEDA Pro.
+When developing EasyEDA extensions, AI can use the extension-development documentation, API references, type information, usage examples, and bridge debugging capabilities provided by this skill to help with API lookup, code generation, and integration debugging.
+If you want to analyze or modify EasyEDA document source files directly instead of operating through the API, this project also provides documentation for the source file formats.
+
+- 📚 **Structured API documentation** — Automatically builds hierarchical indexes from reference docs for fast AI lookup
+- 🧾 **Document source format specifications** — Explains project, schematic, and PCB source formats for direct source analysis and modification
+- 🔌 **WebSocket Bridge** — A Node.js server that bridges AI tools and the EasyEDA client
+- 🤖 **SKILL.md** — A complete skill instruction file
+
+## Quick Start
+
+### 1. Install dependencies
+
+```bash
+npm install
+```
+
+### 2. Build API documentation
+
+```bash
+npm run build:docs
+```
+
+This reads the raw API documentation from the `reference/` directory and generates structured docs into the `docs/` directory.
+
+### 3. Start the WebSocket Bridge server
+
+```bash
+npm run server
+```
+
+The server automatically chooses an available port in the `49620-49629` range and waits for the EasyEDA client to connect.
+
+### 4. Connect from EasyEDA
+
+Install the `run-api-gateway.eext` extension in EasyEDA. Download:
+
+- https://jlcext.com/item/oshwhub-official/run-api-gateway
+
+After the extension is loaded, it connects to the Bridge server automatically by scanning the port range and verifying the handshake.
+
+### 5. Use from an AI coding tool
+
+AI coding tools such as Claude Code, OpenCode, and QwenCode automatically read `SKILL.md` for instructions, then use the HTTP API to send code to EasyEDA:
+
+```bash
+# Check EasyEDA connection status (assuming the service is on port 49620)
+curl http://localhost:49620/health
+
+# Execute EasyEDA code
+curl -X POST http://localhost:49620/execute \
+  -H "Content-Type: application/json" \
+  -d '{"code": "return await eda.dmt_Project.getCurrentProjectInfo();"}'
+```
+
+## One-Command Packaging
+
+```bash
+npm run pack
+```
+
+This performs the following steps:
+1. Build API documentation (`docs/`)
+2. Package `SKILL.md`, documentation, and the server into `dist/easyeda-api/`
+3. Generate `dist/easyeda-api.zip` for upload
+
+If the documentation has already been built, you can skip that step:
+
+```bash
+npm run pack:fast
+```
+
+### Publish to ClawHub
+
+```bash
+npx clawhub@latest publish dist/easyeda-api/
+```
+
+Or upload the zip file at https://clawhub.ai/upload
+
+## Architecture
+
+```
+┌──────────────┐   HTTP/WS     ┌────────────────┐   WebSocket   ┌──────────┐
+│   AI Agent   │ ◄───────────► │ Bridge Server  │ ◄───────────► │  EasyEDA │
+│ (Skill Tool) │  Port Range   │   (Node.js)    │  Port Range   │ (Client) │
+└──────────────┘  49620-49629  └────────────────┘  49620-49629  └──────────┘
+```
+
+## Communication Protocol
+
+| Message Type | Direction | Description |
+|--------------|-----------|-------------|
+| `execute` | AI → EDA | Execute JavaScript code |
+| `result` | EDA → AI | Return execution result |
+| `error` | EDA → AI | Return execution error |
+| `handshake` | Server → Client | Connection verification (includes `service: "easyeda-bridge"`) |
+| `ping/pong` | Bidirectional | Heartbeat |
+
+## Directory Structure
+
+```text
+easyeda-api-skill/
+  SKILL.md              # AgentSkills standard skill definition
+  AGENTS.md             # Agent prompt guide
+  package.json          # Project configuration
+  reference/            # Raw API reference docs (gitignored)
+  docs/                 # Built structured docs (gitignored)
+  format/               # EasyEDA document source format specs (project/schematic/pcb)
+  guide/                # API development guides
+  user-guide/           # User guides
+  server/index.mjs      # WebSocket Bridge server
+  scripts/
+    build-docs.mjs      # Documentation build script
+    pack.mjs            # Packaging script
+  dist/                 # Packaging output (gitignored)
+    easyeda-api/        # Publishable skill directory
+    easyeda-api.zip     # Zip archive for ClawHub upload
+```

package/skill/README.zh-Hans.official.md

@@ -0,0 +1,125 @@
+[English](./README.md) | [简体中文](#)
+
+# EasyEDA API Skill
+
+供 AI 编程工具（Claude Code、OpenCode、QwenCode 等所有支持 [Agent Skills](https://agentskills.io/) 标准的工具）使用的 EasyEDA Pro API 技能包（Skill）。
+
+这个 SKILL 不仅支持 AI 在线调试嘉立创EDA，也支持辅助开发嘉立创EDA扩展。
+在开发嘉立创EDA扩展时，AI 可以使用本 SKILL 提供的扩展开发相关文档、API 参考、类型信息、调用示例以及桥接调试能力，帮助完成接口查询、代码编写与联调验证。
+如果用户准备自行分析或修改嘉立创EDA文档源码，而不是通过 API 操作，也可以使用本项目提供的文档源码格式说明。
+
+- 📚 **结构化 API 文档** — 自动从参考文档生成分层索引，便于 AI 快速查阅
+- 🧾 **文档源码格式规范** — 说明工程、原理图、PCB 文档源码格式，适合直接分析和修改源码的场景
+- 🔌 **WebSocket Bridge** — Node.js 服务端，桥接 AI 和 EasyEDA 客户端
+- 🤖 **SKILL.md** — 完整的技能指导文件
+
+## 快速开始
+
+### 1. 安装依赖
+
+```bash
+npm install
+```
+
+### 2. 构建 API 文档
+
+```bash
+npm run build:docs
+```
+
+这会从 `reference/` 目录读取原始 API 文档，生成结构化文档到 `docs/` 目录。
+
+### 3. 启动 WebSocket Bridge 服务器
+
+```bash
+npm run server
+```
+
+服务器自动在端口范围 `49620-49629` 中选择可用端口启动，等待 EasyEDA 客户端连接。
+
+### 4. EasyEDA 端连接
+
+在嘉立创EDA中安装 `run-api-gateway.eext` 扩展，下载地址：
+
+- https://jlc-ext.com/item/oshwhub/run-api-gateway
+
+扩展加载后会自动连接到 Bridge 服务器（自动扫描端口范围，验证握手后连接）。
+
+### 5. 使用 AI 编程工具
+
+AI 编程工具（Claude Code、OpenCode、QwenCode 等）会自动读取 `SKILL.md` 获取技能指导，通过 HTTP API 向 EDA 发送代码：
+
+```bash
+# 检查 EDA 连接状态（端口自动发现，此处假设服务在 49620）
+curl http://localhost:49620/health
+
+# 执行 EDA 代码
+curl -X POST http://localhost:49620/execute \
+  -H "Content-Type: application/json" \
+  -d '{"code": "return await eda.dmt_Project.getCurrentProjectInfo();"}'
+```
+
+## 一键打包
+
+```bash
+npm run pack
+```
+
+这会执行以下步骤：
+1. 构建 API 文档（`docs/`）
+2. 将 SKILL.md、文档、服务器打包到 `dist/easyeda-api/`
+3. 生成 `dist/easyeda-api.zip` 用于上传
+
+如果文档已构建好，可跳过构建步骤：
+
+```bash
+npm run pack:fast
+```
+
+### 发布到 ClawHub
+
+```bash
+npx clawhub@latest publish dist/easyeda-api/
+```
+
+或上传 zip 文件到 https://clawhub.ai/upload
+
+## 架构
+
+```
+┌──────────────┐   HTTP/WS     ┌────────────────┐   WebSocket   ┌──────────┐
+│   AI Agent   │ ◄───────────► │ Bridge Server  │ ◄───────────► │  EasyEDA │
+│ (Skill Tool) │  Port Range   │   (Node.js)    │  Port Range   │ (Client) │
+└──────────────┘  49620-49629  └────────────────┘  49620-49629  └──────────┘
+```
+
+## 通信协议
+
+| 消息类型 | 方向 | 说明 |
+|----------|------|------|
+| `execute` | AI → EDA | 执行 JS 代码 |
+| `result` | EDA → AI | 返回执行结果 |
+| `error` | EDA → AI | 返回执行错误 |
+| `handshake` | Server → Client | 连接验证（含 `service: "easyeda-bridge"`） |
+| `ping/pong` | 双向 | 心跳检测 |
+
+## 目录结构
+
+```
+easyeda-api-skill/
+  SKILL.md              # AgentSkills 标准技能定义
+  AGENTS.md              # Agent 提示指南
+  package.json          # 项目配置
+  reference/            # 原始 API 参考文档（gitignore）
+  docs/                 # 构建后的结构化文档（gitignore）
+  format/               # 嘉立创EDA文档源码格式规范（project/schematic/pcb）
+  guide/                # API 开发指南（人工撰写）
+  user-guide/           # 用户指南（人工撰写）
+  server/index.mjs      # WebSocket Bridge 服务器
+  scripts/
+    build-docs.mjs      # 文档构建脚本
+    pack.mjs            # 打包脚本
+  dist/                 # 打包输出（gitignore）
+    easyeda-api/        # 可发布的 skill 目录
+    easyeda-api.zip     # 用于 ClawHub 上传的 zip 文件
+```