@windypro-rourou/dsh-eda 0.1.0 → 0.1.2

package/skill/references/classes/SYS_LoadingAndProgressBar.md

@@ -0,0 +1,246 @@
+# SYS\_LoadingAndProgressBar class
+
+System / loading and progress bar class
+
+## Signature
+
+```typescript
+class SYS_LoadingAndProgressBar
+```
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[destroyLoading()](./SYS_LoadingAndProgressBar.md)
+
+</td><td>
+
+</td><td>
+
+Destroy the no-progress loading overlay
+
+</td></tr>
+<tr><td>
+
+[destroyProgressBar()](./SYS_LoadingAndProgressBar.md)
+
+</td><td>
+
+</td><td>
+
+Destroy the progress bar
+
+</td></tr>
+<tr><td>
+
+[showLoading()](./SYS_LoadingAndProgressBar.md)
+
+</td><td>
+
+</td><td>
+
+Show the no-progress loading overlay
+
+</td></tr>
+<tr><td>
+
+[showProgressBar(progress, title)](./SYS_LoadingAndProgressBar.md)
+
+</td><td>
+
+</td><td>
+
+Show the progress bar or set its progress
+
+</td></tr>
+</tbody></table>
+
+---
+
+## 方法详情
+
+### destroyloading
+
+# SYS\_LoadingAndProgressBar.destroyLoading() method
+
+Destroy the no-progress loading overlay
+
+## Signature
+
+```typescript
+function destroyLoading(): void;
+```
+
+## Returns
+
+void
+
+## Example
+
+```javascript
+// 1. 先显示加载覆盖作为销毁对象（与 showLoading 成对演示）
+eda.sys_LoadingAndProgressBar.showLoading();
+console.log('加载覆盖已显示');
+await new Promise(r => setTimeout(r, 800));
+
+// 2. 销毁覆盖，编辑器恢复可操作（同步调用，无返回值）
+eda.sys_LoadingAndProgressBar.destroyLoading();
+console.log('加载覆盖已销毁，编辑器恢复可操作');
+```
+
+### destroyprogressbar
+
+# SYS\_LoadingAndProgressBar.destroyProgressBar() method
+
+Destroy the progress bar
+
+## Signature
+
+```typescript
+function destroyProgressBar(): void;
+```
+
+## Returns
+
+void
+
+## Example
+
+```javascript
+// 1. 先显示一个进度未满的进度条作为销毁对象
+eda.sys_LoadingAndProgressBar.showProgressBar(50, '嘉立创示例 正在处理');
+console.log('进度条已显示，当前进度 50%');
+await new Promise(r => setTimeout(r, 800));
+
+// 2. 销毁进度条（同步调用，无返回值）
+eda.sys_LoadingAndProgressBar.destroyProgressBar();
+console.log('进度条已销毁');
+```
+
+### showloading
+
+# SYS\_LoadingAndProgressBar.showLoading() method
+
+Show the no-progress loading overlay
+
+## Signature
+
+```typescript
+function showLoading(): void;
+```
+
+## Returns
+
+void
+
+## Remarks
+
+There is no progress indicator, but a gray overlay consistent with the progress bar will appear to prevent further user operations
+
+## Example
+
+```javascript
+// 1. 显示无进度加载覆盖（同步调用，无返回值）
+eda.sys_LoadingAndProgressBar.showLoading();
+console.log('加载覆盖已显示，编辑器被灰色覆盖锁定');
+
+// 2. 停留片刻便于观察，随后销毁覆盖还原界面（自建自删，保证案例可重复运行）
+await new Promise(r => setTimeout(r, 1000));
+eda.sys_LoadingAndProgressBar.destroyLoading();
+console.log('加载覆盖已销毁，编辑器恢复可操作');
+```
+
+### showprogressbar
+
+# SYS\_LoadingAndProgressBar.showProgressBar() method
+
+Show the progress bar or set its progress
+
+## Signature
+
+```typescript
+function showProgressBar(progress?: number, title?: string): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+progress
+
+</td><td>
+
+number
+
+</td><td>
+
+_(Optional)_ Progress value, value range `0-100`
+
+</td></tr>
+<tr><td>
+
+title
+
+</td><td>
+
+string
+
+</td><td>
+
+_(Optional)_ Progress bar title
+
+</td></tr>
+</tbody></table>
+
+## Returns
+
+void
+
+## Remarks
+
+When the progress reaches `100`<!-- -->, the progress bar will be automatically destroyed
+
+## Example
+
+```javascript
+// 1. 显示进度条并指定标题（同步调用，无返回值）
+eda.sys_LoadingAndProgressBar.showProgressBar(30, '嘉立创示例 正在处理');
+console.log('进度条已显示，当前进度 30%');
+
+// 2. 重复调用刷新进度（分批任务逐步推进的典型方式）
+await new Promise(r => setTimeout(r, 800));
+eda.sys_LoadingAndProgressBar.showProgressBar(70, '嘉立创示例 正在处理');
+console.log('进度已更新到 70%');
+
+// 3. 进度达到 100，进度条自动销毁（自清理，无需手动 destroy）
+await new Promise(r => setTimeout(r, 800));
+eda.sys_LoadingAndProgressBar.showProgressBar(100, '嘉立创示例 正在处理');
+console.log('进度达到 100%，进度条已自动销毁');
+```

package/skill/references/classes/SYS_Log.md

@@ -0,0 +1,424 @@
+# SYS\_Log class
+
+System / log class
+
+## Signature
+
+```typescript
+class SYS_Log
+```
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[add(message, type)](./SYS_Log.md)
+
+</td><td>
+
+</td><td>
+
+Add a log entry
+
+</td></tr>
+<tr><td>
+
+[clear()](./SYS_Log.md)
+
+</td><td>
+
+</td><td>
+
+Clear the log
+
+</td></tr>
+<tr><td>
+
+[export(types)](./SYS_Log.md)
+
+</td><td>
+
+</td><td>
+
+Export the log
+
+</td></tr>
+<tr><td>
+
+[find(message, types)](./SYS_Log.md)
+
+</td><td>
+
+</td><td>
+
+Find entries
+
+</td></tr>
+<tr><td>
+
+[sort(types)](./SYS_Log.md)
+
+</td><td>
+
+</td><td>
+
+Filter and get log entries
+
+</td></tr>
+</tbody></table>
+
+---
+
+## 方法详情
+
+### add
+
+# SYS\_Log.add() method
+
+Add a log entry
+
+## Signature
+
+```typescript
+function add(message: string, type?: ESYS_LogType): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+message
+
+</td><td>
+
+string
+
+</td><td>
+
+Log content
+
+</td></tr>
+<tr><td>
+
+type
+
+</td><td>
+
+[ESYS\_LogType](../enums/ESYS_LogType.md)
+
+</td><td>
+
+_(Optional)_ Log type
+
+</td></tr>
+</tbody></table>
+
+## Returns
+
+void
+
+## Example
+
+```javascript
+// 1. 写入三条不同类型的日志（同步调用，立即生效）
+eda.sys_Log.add('嘉立创示例_插件启动，开始处理任务');
+eda.sys_Log.add('嘉立创示例_检测到网络波动，将自动重试', 'warn');
+eda.sys_Log.add('嘉立创示例_文件解析失败', 'error');
+
+// 2. 查询日志面板，确认条目已写入（find 返回 Promise，需要 await）
+const found = await eda.sys_Log.find('嘉立创示例_');
+console.log('写入的日志条目数：', found.length);
+console.log('其中一条：', found[0].message, '（类型：', `${found[0].type}）`);
+```
+
+### clear
+
+# SYS\_Log.clear() method
+
+Clear the log
+
+## Signature
+
+```typescript
+function clear(): void;
+```
+
+## Returns
+
+void
+
+## Example
+
+```javascript
+// 1. 先写入几条示例日志，让清空效果可见
+eda.sys_Log.add('嘉立创示例_清空前日志 1');
+eda.sys_Log.add('嘉立创示例_清空前日志 2', 'warn');
+const before = await eda.sys_Log.sort();
+console.log('清空前的日志条目数：', before.length);
+
+// 2. 清空日志面板（同步调用，立即生效）
+eda.sys_Log.clear();
+
+// 3. 再次查询，确认面板已清空
+const after = await eda.sys_Log.sort();
+console.log('清空后的日志条目数：', after.length);
+```
+
+### export
+
+# SYS\_Log.export() method
+
+Export the log
+
+## Signature
+
+```typescript
+function export(types?: ESYS_LogType | Array<ESYS_LogType>): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+types
+
+</td><td>
+
+[ESYS\_LogType](../enums/ESYS_LogType.md) \| Array&lt;[ESYS\_LogType](../enums/ESYS_LogType.md)<!-- -->&gt;
+
+</td><td>
+
+_(Optional)_ Log type
+
+</td></tr>
+</tbody></table>
+
+## Returns
+
+void
+
+## Example
+
+```javascript
+// 1. 先写入几条不同类型的日志，保证导出内容可辨识
+eda.sys_Log.add('嘉立创示例_导出演示：信息条目');
+eda.sys_Log.add('嘉立创示例_导出演示：警告条目', 'warn');
+
+// 2. 导出全部日志（同步调用，触发一次文件保存）
+eda.sys_Log.export();
+console.log('已导出全部日志');
+
+// 3. 按类型筛选导出，只导出警告和错误级别（数组可同时指定多种类型）
+eda.sys_Log.export(['warn', 'error']);
+console.log('已导出 warn 和 error 类型的日志');
+```
+
+### find
+
+# SYS\_Log.find() method
+
+Find entries
+
+## Signature
+
+```typescript
+function find(
+	message:
+		| string
+		| Array<
+			| string
+			| {
+				text: string;
+				attr?:
+					| undefined
+					| {
+						id?: undefined | string;
+						path?: undefined | string;
+						sheet?: undefined | string;
+						pcbid?: undefined | string;
+						type?: undefined | string;
+					};
+			}
+		>,
+	types?: ESYS_LogType | Array<ESYS_LogType>,
+): Promise<Array<ISYS_LogLine>>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+message
+
+</td><td>
+
+string \| Array&lt;string \| { text: string; attr?: undefined \| { id?: undefined \| string; path?: undefined \| string; sheet?: undefined \| string; pcbid?: undefined \| string; type?: undefined \| string } }&gt;
+
+</td><td>
+
+Find content
+
+</td></tr>
+<tr><td>
+
+types
+
+</td><td>
+
+[ESYS\_LogType](../enums/ESYS_LogType.md) \| Array&lt;[ESYS\_LogType](../enums/ESYS_LogType.md)<!-- -->&gt;
+
+</td><td>
+
+_(Optional)_ Array of log types. The search can be performed within the specified log types
+
+</td></tr>
+</tbody></table>
+
+## Returns
+
+Promise&lt;Array&lt;[ISYS\_LogLine](../interfaces/ISYS_LogLine.md)<!-- -->&gt;&gt;
+
+Array of log entries matching the find criteria
+
+## Remarks
+
+If the log panel is open, the find operation will also be displayed on the front end
+
+## Example
+
+```javascript
+// 1. 写入待查找的示例日志（一条 info、一条 error）
+eda.sys_Log.add('嘉立创示例_查找演示：任务开始');
+eda.sys_Log.add('嘉立创示例_查找演示：网络请求失败', 'error');
+
+// 2. 按关键字查找全部匹配条目（返回 Promise，需要 await）
+const all = await eda.sys_Log.find('嘉立创示例_查找演示');
+console.log('关键字匹配条目数：', all.length);
+
+// 3. 限定只在 error 类型中查找，缩小搜索范围
+const errors = await eda.sys_Log.find('嘉立创示例_查找演示', 'error');
+console.log('error 类型匹配条目数：', errors.length);
+console.log('匹配内容：', errors.map(line => line.message).join('；'));
+```
+
+### sort
+
+# SYS\_Log.sort() method
+
+Filter and get log entries
+
+## Signature
+
+```typescript
+function sort(types?: ESYS_LogType | Array<ESYS_LogType>): Promise<Array<ISYS_LogLine>>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+types
+
+</td><td>
+
+[ESYS\_LogType](../enums/ESYS_LogType.md) \| Array&lt;[ESYS\_LogType](../enums/ESYS_LogType.md)<!-- -->&gt;
+
+</td><td>
+
+_(Optional)_ Array of log types. Multiple log types can be specified at the same time. If not specified, all types are used
+
+</td></tr>
+</tbody></table>
+
+## Returns
+
+Promise&lt;Array&lt;[ISYS\_LogLine](../interfaces/ISYS_LogLine.md)<!-- -->&gt;&gt;
+
+Array of log entries matching the filter criteria
+
+## Remarks
+
+If the log panel is open, the filter operation will also be displayed on the front end
+
+## Example
+
+```javascript
+// 1. 写入三种不同类型的示例日志，便于观察筛选效果
+eda.sys_Log.add('嘉立创示例_筛选演示：常规信息');
+eda.sys_Log.add('嘉立创示例_筛选演示：电压偏高', 'warn');
+eda.sys_Log.add('嘉立创示例_筛选演示：铺铜失败', 'error');
+
+// 2. 不传参数，获取全部类型的日志（返回 Promise，需要 await）
+const all = await eda.sys_Log.sort();
+console.log('全部日志条目数：', all.length);
+
+// 3. 传入类型数组，只筛选警告和错误两类
+const problems = await eda.sys_Log.sort(['warn', 'error']);
+console.log('警告和错误条目数：', problems.length);
+console.log('问题明细：', problems.map(line => `[${line.type}] ${line.message}`).join('；'));
+```