dsh-plugin-office-fill-tool 0.2.0 → 0.2.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 tenfeng
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,75 +1,73 @@
-# office fill tool（DSH 插件）
+# dsh-plugin-office-fill-tool
 
-在 DeepSeek Harness 中批量生成 Office 文件：传入模板、数据台账和输出目录，返回生成的文件列表。
+DeepSeek Harness（DSH）插件：根据 Excel/Word 模板和数据台账批量生成文件，并向模型返回生成的文件列表。
 
-## 形态
+## 功能
 
-- **bundle 插件**：`package.json` 声明 `dsh.bundle.patch`，由 `cordis.patch.yml` 插入插件行。
-- 入口 `index.js` 注册两个工具：
-  - `batch_generate_files`：无界面批量生成，返回 `folder`、`count`、`files`。
-  - `open_office_fill_tool`：打开图形界面，供手动操作。
-- `bin/office fill tool.exe` + `bin/_internal/`：PyInstaller onedir 程序，同时支持 GUI 和 `--cli` 模式。
+- `batch_generate_files`：传入 `template`、`data`、`output_dir`、`mode`，后台生成并返回 `folder` / `count` / `files`。
+- `open_office_fill_tool`：打开 Windows 图形界面，手动操作。
+- 支持 Excel（`.xlsx`）和 Word（`.docx`）模板。
+- 保留模板的单元格边框、行级格式、合并单元格等格式。
 
 ## 安装
 
-```sh
-dsh plugin --profile desktop add "C:\Users\Administrator\Desktop\DSH工作区\office fill tool"
-dsh --profile desktop --dump-config
+要求：Windows、DSH 版本 `>= 0.2.1-rc.2`。
+
+```powershell
+dsh plugin --profile desktop add github:ten-feng/dsh-plugin-office-fill-tool
 ```
 
-发布给其他人：
+安装后重启 DSH，在插件页应看到 `office fill tool`。
 
-```sh
-# npm（先 pnpm publish）
-dsh plugin --profile desktop add dsh-plugin-office-fill-tool
+也可以使用本地目录或 tarball 安装：
 
-# tarball
-pnpm pack
-dsh plugin --profile desktop add .\dsh-plugin-office-fill-tool-0.1.0.tgz
+```powershell
+dsh plugin --profile desktop add "C:\path\to\dsh-plugin-office-fill-tool"
+dsh plugin --profile desktop add .\dsh-plugin-office-fill-tool-0.2.0.tgz
 ```
 
-## 工具参数
+## 使用示例
 
-`batch_generate_files`：
+在 DSH 对话中：
 
-| 参数 | 必填 | 说明 |
-|---|---|---|
-| `template` | 是 | Excel 模式用 `.xlsx` 模板；Word 模式用 `.docx` 模板 |
-| `data` | 是 | 数据台账 `.xlsx`，第一行为表头 |
-| `output_dir` | 是 | 输出目录（会在其下创建 `生成文件_YYYYMMDD`） |
-| `mode` | 否 | `excel`（默认）或 `word` |
+> 用 batch_generate_files 生成文件：
+> template = C:\...\模板.xlsx
+> data = C:\...\台账.xlsx
+> output_dir = C:\...\输出
+> mode = excel
 
 返回：
 
 ```json
 {
-  "folder": "输出目录\\生成文件_20261025",
+  "folder": "C:\\...\\输出\\生成文件_20261025",
   "count": 9,
-  "files": ["...xlsx", "...xlsx"]
+  "files": ["C:\\...\\A区.xlsx", "C:\\...\\B区.xlsx"]
 }
 ```
 
-当前 Agent 看到的文本形式：
+## 目录结构
 
 ```text
-已生成 9 个文件
-输出目录：...
-- ...\A区...xlsx
-- ...\B区...xlsx
+.
+├─ package.json
+├─ index.js
+├─ cordis.patch.yml
+├─ README.md
+├─ LICENSE
+└─ bin/
+   ├─ office fill tool.exe
+   └─ _internal/
 ```
 
-## CLI 模式（exe 直接调用）
-
-```bat
-"office fill tool.exe" --cli --mode excel ^
-  --template "模板.xlsx" --data "台账.xlsx" ^
-  --output "输出目录" --result-file "result.json"
-```
+## 限制
 
-结果 JSON 写入 `--result-file`，同时尽量打印到 stdout。`ok` 为 `false` 时附带 `error` 和 `messages`。
+- 仅 Windows 可用（exe 为 Windows 程序）。
+- 生成配置和日志写在 `bin/` 目录。
+- 第一次调用时 DSH 需要能执行本机 exe，部分安全软件可能拦截。
 
-## 限制
+## 卸载
 
-- 仅 Windows 可用。
-- 生成器会把配置/日志写在 `bin/` 目录；升级插件时可能丢失。
-- Word 模板中的页眉页脚、文本框等仍沿用 2.3 的替换范围。
+```powershell
+dsh plugin --profile desktop remove dsh-plugin-office-fill-tool
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dsh-plugin-office-fill-tool",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "Batch-generate Office files from templates and data ledgers, returning the generated file list.",
   "type": "module",
   "main": "index.js",
@@ -28,5 +28,10 @@
   "peerDependencies": {
     "@deepseek-ai/dsh-tools": "*"
   },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ten-feng/dsh-plugin-office-fill-tool.git"
+  },
+  "homepage": "https://github.com/ten-feng/dsh-plugin-office-fill-tool#readme",
   "license": "MIT"
 }