dsh-desk-todo 2.0.0 → 2.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +220 -160
  2. package/package.json +11 -2
package/README.md CHANGED
@@ -1,160 +1,220 @@
1
- # dsh-desk-todo · 桌面待办挂件
2
-
3
- 把「**本周待办 + 长期任务**」贴在桌面右上角的一块小黑板上：无标题栏、不进任务栏、默认沉在窗口下面不挡东西；到点弹窗 + 叮一声。
4
-
5
- ![本周视图](docs/screenshot-week.png)
6
-
7
- - 左边：今天起 7 天的待办（没安排的周末也留一行，看得见周末）
8
- - 右边：长期任务和 DDL 倒计时
9
- - 单击任意一条 → 看/改备注、标记完成、删除
10
- - 标题栏 **＋** → 一句话快速新增（`15号下午3点在图书馆交作业` 这种）
11
-
12
- ## 实现方式
13
-
14
- 界面是 **Electron** 挂件（`app/`，无边框 + 透明 + 沉底），插件只负责找到一份 Electron 二进制并把它拉起来、崩了重启。
15
-
16
- 为什么插件不自己开窗口：DSH 的插件宿主跑在 `ELECTRON_RUN_AS_NODE` 模式（`dsh-desktop-host`），进程里没有 `app` / `BrowserWindow`。
17
-
18
- Electron 搜索顺序：
19
-
20
- 1. 配置项 `electronPath`
21
- 2. 环境变量 `DESH_DESK_TODO_ELECTRON`（见下方示例）
22
- 3. `$DSH_HOME/data/surfcore/pet/runtime/electron-<ver>/electron.exe`（装了桌宠插件就有）
23
- 4. `%LOCALAPPDATA%\Programs\electron\electron.exe`
24
-
25
- 都找不到时**自动退回 WPF 版本**（`win/desk-todo.ps1`，Windows 自带，不需要 Electron，界面是同一套布局的简化实现）。
26
-
27
- | 层 | 技术 | 说明 |
28
- |---|---|---|
29
- | 界面 | Electron（首选）/ WPF（退路） | 无边框透明窗口 |
30
- | 提醒 | 自绘弹窗 + `SoundPlayer` / `Notification` | 不吃系统通知权限 |
31
- | 一句话识别 | Node 正则解析器（`lib/parse.js`） | 通过 `127.0.0.1` 临时端口给界面调用 |
32
- | 数据 | `$DSH_HOME/desk-todo/data.json` | 纯文本，改完自动刷新 |
33
-
34
- ## 安装
35
-
36
- ```bash
37
- dsh plugin --profile desktop add dsh-desk-todo
38
- # 或者
39
- dsh plugin --profile desktop add github:Astryve/dsh-desk-todo
40
- ```
41
-
42
- 装完**重启 DSH**，挂件会出现在屏幕右上角。
43
-
44
- 本地开发：
45
-
46
- ```bash
47
- git clone https://github.com/Astryve/dsh-desk-todo
48
- dsh plugin --profile desktop add link:/绝对路径/dsh-desk-todo
49
- ```
50
-
51
- ## 第一次打开
52
-
53
- - 挂件是空的（只有 7 天日期 + 空长期区）
54
- - 数据文件被创建在 `$DSH_HOME/desk-todo/data.json`（Windows 默认 `C:\Users\<你>\.dsh\desk-todo\data.json`；本机把 DSH 数据放 D 盘时就是 `D:\DSH\data\desk-todo\`）
55
- - 想立刻看到效果，把仓库里的 `data/example.json` 复制成 `data.json` 即可
56
-
57
- ## 怎么加待办
58
-
59
- ### 一句话识别（推荐）
60
-
61
- 点 **＋**，输入：
62
-
63
- ```
64
- 15号下午3点在图书馆交作业
65
- ```
66
-
67
- 会自动拆成 `2026-11-15 · 15:00–16:00 · 图书馆 · 交作业`。识别服务由插件提供；插件没起来时退化为「今天 09:00 + 原文标题」。
68
-
69
- 支持：
70
-
71
- | 类型 | 例子 |
72
- |---|---|
73
- | 日期 | `15号` `11月20日` `2026-11-20` `今天/明天/后天` `周五` `下周一` |
74
- | 时间 | `3点` `7点半` `十点` `9点到11点`，可配 `上午/下午/晚上/中午` |
75
- | 地点 | `在图书馆` `地点：主楼W3阶`，也认 `东区414` `W3阶` `宿舍楼下` |
76
- | 标题 | 自动去掉时间地点，只留动作 |
77
-
78
- ### 改 JSON
79
-
80
- `data.json` 是普通 JSON，改完存盘挂件自动刷新。字段见下。
81
-
82
- ## 提醒规则
83
-
84
- | 时机 | 表现 |
85
- |---|---|
86
- | 提前 N 分钟（默认 15，可设 0） | 右下角弹窗 + 轻提示音 |
87
- | 到点 | 弹窗 + 更响提示音 |
88
- | 逾期未完成 | 每 10 分钟一次，最多 3 次 |
89
- | 长期任务临期 | 剩 3 天 / 1 天 / 当天各一次 |
90
-
91
- ## 鼠标操作
92
-
93
- | 操作 | 效果 |
94
- |---|---|
95
- | 拖标题栏 | 移动（位置自动记住） |
96
- | 点 ＋ | 快速新增 |
97
- | 点 － | 隐藏（插件仍在跑，重启 DSH 会回来） |
98
- | 点条目 | 详情：备注、完成、删除 |
99
-
100
- ## 数据格式
101
-
102
- ```json
103
- {
104
- "semester": { "name": "2026-2027 秋", "week1Monday": "2026-08-31" },
105
- "events": [
106
- { "id": "e1", "title": "数值分析", "day": "2026-11-12",
107
- "start": "13:30", "end": "16:40", "place": "武进阶教楼W3阶",
108
- "color": "gold", "remindMin": 15, "repeat": "weekly", "note": "带作业" }
109
- ],
110
- "longterm": [
111
- { "id": "l1", "title": "毕业设计开题", "due": "2026-12-20", "done": false, "note": "" }
112
- ],
113
- "settings": { "w": 520, "h": 330, "x": null, "y": 16, "opacity": 0.85 }
114
- }
115
- ```
116
-
117
- | 字段 | 说明 |
118
- |---|---|
119
- | `day` | `YYYY-MM-DD`；`repeat: "weekly"` 时它决定周几 |
120
- | `start` / `end` | `HH:MM` 24 小时制 |
121
- | `place` | 自动简写：`武进东区国际教室414` → `东区414` |
122
- | `color` | 色条：`gold` `green` `blue` `pink` `orange` |
123
- | `remindMin` | 提前几分钟；`0` = 只到点提醒 |
124
- | `doneOn` | 某天标记完成的日子（每周重复的第二天自动恢复） |
125
- | `semester.week1Monday` | 有它标题就显示「第 N 周」 |
126
-
127
- ## 配置
128
-
129
- ```yaml
130
- # ~/.dsh/profiles/<profile>/cordis.patch.yml
131
- - id: desk-todo
132
- config:
133
- alwaysOnTop: true # 想让它盖在窗口上面就打开（默认 false = 沉底）
134
- silent: true # 只弹窗不出声
135
- width: 520
136
- height: 330
137
- top: 16
138
- right: 16
139
- ```
140
-
141
- ## 常见问题
142
-
143
- **装完没看到？**
144
- ① 重启 DSH 了吗；② 挂件默认沉在最底层，最小化其它窗口才看得到；③ 打开 `%TEMP%\desk-todo-load.txt`，没有 `spawned powershell pid=...` 就是插件没被加载。
145
-
146
- **弹窗不响？**
147
- 配置里 `silent: true` 关了声音，或系统音量/输出设备不对。
148
-
149
- **能改窗口大小吗？**
150
- 改 `data.json` 里 `settings.w/h`，或配置里 `width/height`（只影响首次创建）。
151
-
152
- **数据会不会丢？**
153
- 不会，全在 `data.json`；卸载插件不删数据。
154
-
155
- **非 Windows？**
156
- WPF 只有 Windows 有，这个版本不支持 macOS / Linux。
157
-
158
- ## License
159
-
160
- MIT
1
+ # dsh-desk-todo · 桌面待办挂件
2
+
3
+ 把「**本周待办 + 长期任务**」贴在桌面右上角的一块小黑板上：无标题栏、不进任务栏、默认沉在窗口下面不挡东西；到点弹窗 + 叮一声。
4
+
5
+ ![本周视图](docs/screenshot-week.png)
6
+
7
+ - 左边：今天起 7 天的待办（没安排的周末也留一行，看得见周末）
8
+ - 右边：长期任务和 DDL 倒计时
9
+ - 单击任意一条 → 看/改备注、标记完成、删除
10
+ - 标题栏 **＋** → 一句话快速新增（`15号下午3点在图书馆交作业` 这种）
11
+
12
+ ## 实现方式
13
+
14
+ 界面是 **Electron** 挂件（`app/`，无边框 + 透明 + 沉底），插件只负责找到一份 Electron 二进制并把它拉起来、崩了重启。
15
+
16
+ 为什么插件不自己开窗口：DSH 的插件宿主跑在 `ELECTRON_RUN_AS_NODE` 模式（`dsh-desktop-host`），进程里没有 `app` / `BrowserWindow`。
17
+
18
+ Electron 搜索顺序：
19
+
20
+ 1. 配置项 `electronPath`
21
+ 2. 环境变量 `DESH_DESK_TODO_ELECTRON`（见下方示例）
22
+ 3. `$DSH_HOME/data/surfcore/pet/runtime/electron-<ver>/electron.exe`（装了桌宠插件就有）
23
+ 4. `%LOCALAPPDATA%\Programs\electron\electron.exe`
24
+
25
+ 都找不到时**自动退回 WPF 版本**（`win/desk-todo.ps1`，Windows 自带，不需要 Electron，界面是同一套布局的简化实现）。
26
+
27
+ | 层 | 技术 | 说明 |
28
+ |---|---|---|
29
+ | 界面 | Electron（首选）/ WPF（退路） | 无边框透明窗口 |
30
+ | 提醒 | 自绘弹窗 + `SoundPlayer` / `Notification` | 不吃系统通知权限 |
31
+ | 一句话识别 | Node 正则解析器（`lib/parse.js`） | 通过 `127.0.0.1` 临时端口给界面调用 |
32
+ | 数据 | `$DSH_HOME/desk-todo/data.json` | 纯文本，改完自动刷新 |
33
+
34
+ ## 安装
35
+
36
+ ### 方式一：从 npm（推荐）
37
+
38
+ ```bash
39
+ dsh plugin --profile desktop add dsh-desk-todo
40
+ ```
41
+
42
+ - npm 页面：https://www.npmjs.com/package/dsh-desk-todo
43
+ - 当前版本：`2.0.0`，发布者 `astryve`
44
+ - 也可以直接在 DSH 插件市场搜索 **待办 / todo / desk**
45
+
46
+ ### 方式二：从 GitHub
47
+
48
+ ```bash
49
+ dsh plugin --profile desktop add github:Astryve/dsh-desk-todo
50
+ ```
51
+
52
+ 适合想跟最新提交（可能比 npm 版本新）的人。
53
+
54
+ ### 方式三：本地源码
55
+
56
+ ```bash
57
+ git clone https://github.com/Astryve/dsh-desk-todo
58
+ dsh plugin --profile desktop add link:/绝对路径/dsh-desk-todo
59
+ ```
60
+
61
+ 装完**重启 DSH**（插件在启动时加载），挂件出现在屏幕右上角。
62
+
63
+ ## 机器要求
64
+
65
+ | 项 | 要求 |
66
+ |---|---|
67
+ | 系统 | **Windows 10 / 11**（用的是 Win32 窗口 + PowerShell） |
68
+ | DSH | 桌面版（Web 版没有桌面窗口，装了也看不到） |
69
+ | Electron | 有最好（界面是 Electron 版）；没有会自动退回 WPF 版 |
70
+ | Node | 不需要你装，DSH 自带 |
71
+
72
+ Electron 从哪来：如果你装过 `桌宠` 这类插件，它的运行目录里就有一份；插件会自动找到。找不到也不影响使用，只是界面换成 WPF 实现。
73
+
74
+ ## 第一次打开
75
+
76
+ - 挂件是空的（只有 7 天日期 + 空长期区）
77
+ - 数据文件被创建在 `$DSH_HOME/desk-todo/data.json`（Windows 默认 `C:\Users\<你>\.dsh\desk-todo\data.json`；本机把 DSH 数据放 D 盘时就是 `D:\DSH\data\desk-todo\`）
78
+ - 想立刻看到效果，把仓库里的 `data/example.json` 复制成 `data.json` 即可
79
+
80
+ ## 怎么加待办
81
+
82
+ ### 一句话识别（推荐）
83
+
84
+ 点 **＋**，输入：
85
+
86
+ ```
87
+ 15号下午3点在图书馆交作业
88
+ ```
89
+
90
+ 会自动拆成 `2026-11-15 · 15:00–16:00 · 图书馆 · 交作业`。识别服务由插件提供；插件没起来时退化为「今天 09:00 + 原文标题」。
91
+
92
+ 支持：
93
+
94
+ | 类型 | 例子 |
95
+ |---|---|
96
+ | 日期 | `15号` `11月20日` `2026-11-20` `今天/明天/后天` `周五` `下周一` |
97
+ | 时间 | `3点` `7点半` `十点` `9点到11点`，可配 `上午/下午/晚上/中午` |
98
+ | 地点 | `在图书馆` `地点：主楼W3阶`，也认 `东区414` `W3阶` `宿舍楼下` |
99
+ | 标题 | 自动去掉时间地点，只留动作 |
100
+
101
+ ### 改 JSON
102
+
103
+ `data.json` 是普通 JSON，改完存盘挂件自动刷新。字段见下。
104
+
105
+ ## 提醒规则
106
+
107
+ | 时机 | 表现 |
108
+ |---|---|
109
+ | 提前 N 分钟（默认 15，可设 0） | 右下角弹窗 + 轻提示音 |
110
+ | 到点 | 弹窗 + 更响提示音 |
111
+ | 逾期未完成 | 每 10 分钟一次，最多 3 次 |
112
+ | 长期任务临期 | 剩 3 天 / 1 天 / 当天各一次 |
113
+
114
+ ## 鼠标操作
115
+
116
+ | 操作 | 效果 |
117
+ |---|---|
118
+ | 拖标题栏 | 移动（位置自动记住） |
119
+ | 左键 **＋** | 新增待办（日期 / 时间 / 地点 / 提前提醒 / 重复 / 备注） |
120
+ | **右键 ＋** | 新增长期任务（标题 + DDL） |
121
+ | **⚙** | 尺寸、背景不透明度 |
122
+ | **－** | 隐藏（插件仍在跑，重启 DSH 会回来） |
123
+ | 点条目 | 详情：改备注、标记完成、编辑、删除 |
124
+
125
+ 编辑框里的**备注**可以写一句人话，点「识别」自动拆成日期/时间/地点/标题。
126
+
127
+ ## 数据格式
128
+
129
+ ```json
130
+ {
131
+ "semester": { "name": "2026-2027 秋", "week1Monday": "2026-08-31" },
132
+ "events": [
133
+ { "id": "e1", "title": "数值分析", "day": "2026-11-12",
134
+ "start": "13:30", "end": "16:40", "place": "武进阶教楼W3阶",
135
+ "color": "gold", "remindMin": 15, "repeat": "weekly", "note": "带作业" }
136
+ ],
137
+ "longterm": [
138
+ { "id": "l1", "title": "毕业设计开题", "due": "2026-12-20", "done": false, "note": "" }
139
+ ],
140
+ "settings": { "w": 520, "h": 330, "x": null, "y": 16, "opacity": 0.85 }
141
+ }
142
+ ```
143
+
144
+ | 字段 | 说明 |
145
+ |---|---|
146
+ | `day` | `YYYY-MM-DD`；`repeat: "weekly"` 时它决定周几 |
147
+ | `start` / `end` | `HH:MM` 24 小时制 |
148
+ | `place` | 自动简写：`武进东区国际教室414` → `东区414` |
149
+ | `color` | 色条：`gold` `green` `blue` `pink` `orange` |
150
+ | `remindMin` | 提前几分钟；`0` = 只到点提醒 |
151
+ | `doneOn` | 某天标记完成的日子（每周重复的第二天自动恢复） |
152
+ | `semester.week1Monday` | 有它标题就显示「第 N 周」 |
153
+
154
+ ## 配置
155
+
156
+ ```yaml
157
+ # ~/.dsh/profiles/<profile>/cordis.patch.yml
158
+ - id: desk-todo
159
+ config:
160
+ alwaysOnTop: true # 想让它盖在窗口上面就打开（默认 false = 沉底）
161
+ silent: true # 只弹窗不出声
162
+ width: 520
163
+ height: 330
164
+ top: 16
165
+ right: 16
166
+ ```
167
+
168
+ ## 常见问题
169
+
170
+ **装完没看到？**
171
+
172
+ 1. 重启 DSH 了吗（插件只在启动时加载）
173
+ 2. 挂件默认沉在最底层，最小化其它窗口才看得到
174
+ 3. 打开 `%TEMP%\desk-todo-load.txt` 看：
175
+ - `api 端口=...` + `spawned electron pid=...` → 插件起来了，窗口被别的窗口盖住
176
+ - `没找到 Electron，退回 WPF` → 用的是 WPF 版，界面会简化
177
+ - 文件不存在 → 插件没被加载，跑 `dsh plugin list` 检查
178
+
179
+ **弹窗不响？**
180
+ 配置里 `silent: true` 关了声音，或系统音量 / 输出设备不对。
181
+
182
+ **能改窗口大小吗？**
183
+ 点 ⚙ 直接改；或改 `data.json` 里 `settings.w/h`。配置里的 `width/height` 只影响首次创建。
184
+
185
+ **数据会不会丢？**
186
+ 不会，全在 `data.json`；卸载插件不删数据。想备份就复制这个文件。
187
+
188
+ **在插件市场搜不到？**
189
+ 市场是定期扫 npm 上带 `dsh-plugin` 关键词的包，新包要等几小时到一天。着急就直接用命令装。
190
+
191
+ **非 Windows？**
192
+ 这个版本只支持 Windows（桌面窗口用 Win32 + PowerShell）。
193
+
194
+ ## 更新与卸载
195
+
196
+ ```bash
197
+ # 更新到最新版
198
+ dsh plugin --profile desktop add dsh-desk-todo@latest
199
+
200
+ # 卸载（数据保留）
201
+ dsh plugin --profile desktop remove dsh-desk-todo
202
+ ```
203
+
204
+ ## 版本
205
+
206
+ | 版本 | 变化 |
207
+ |---|---|
208
+ | 2.0.0 | 回到 Electron 实现（插件负责找 Electron 并拉起），WPF 作为找不到时的退路；发布到 npm |
209
+ | 1.1.1 | WPF 版：补设置按钮、悬停、阴影 |
210
+ | 1.0.0 | 首个版本（Electron 独立程序形态） |
211
+
212
+ ## 相关链接
213
+
214
+ - GitHub：https://github.com/Astryve/dsh-desk-todo
215
+ - npm：https://www.npmjs.com/package/dsh-desk-todo
216
+ - 问题反馈：https://github.com/Astryve/dsh-desk-todo/issues
217
+
218
+ ## License
219
+
220
+ MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "dsh-desk-todo",
3
- "version": "2.0.0",
3
+ "version": "2.0.1",
4
4
  "description": "DSH 桌面待办挂件：Electron 透明窗口（找不到 Electron 时自动退回 WPF），到点弹窗 + 提示音提醒。",
5
5
  "type": "module",
6
6
  "main": "lib/index.js",
@@ -45,5 +45,14 @@
45
45
  },
46
46
  "os": [
47
47
  "win32"
48
- ]
48
+ ],
49
+ "repository": {
50
+ "type": "git",
51
+ "url": "git+https://github.com/Astryve/dsh-desk-todo.git"
52
+ },
53
+ "homepage": "https://github.com/Astryve/dsh-desk-todo#readme",
54
+ "bugs": {
55
+ "url": "https://github.com/Astryve/dsh-desk-todo/issues"
56
+ },
57
+ "author": "astryve"
49
58
  }