@zmskco/dsh-notebook 0.0.0-stage → 0.1.0
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.
- package/LICENSE +23 -0
- package/README.md +95 -2
- package/cordis.patch.yml +7 -0
- package/icon.svg +9 -0
- package/lib/client.js +15135 -0
- package/lib/config.js +43 -0
- package/lib/dsh.js +1 -0
- package/lib/errors.js +20 -0
- package/lib/http/api.js +179 -0
- package/lib/http/media.js +187 -0
- package/lib/http/reveal.js +68 -0
- package/lib/http/status.js +15 -0
- package/lib/index.js +89 -0
- package/lib/render/backend.js +247 -0
- package/lib/render/jobs.js +267 -0
- package/lib/render/png.js +125 -0
- package/lib/story/bootstrap.js +45 -0
- package/lib/story/focus.js +43 -0
- package/lib/story/manuscript.js +49 -0
- package/lib/story/paths.js +95 -0
- package/lib/story/project.js +289 -0
- package/lib/story/readme.js +26 -0
- package/lib/story/root.js +60 -0
- package/lib/story/sandbox.js +186 -0
- package/lib/story/workspace.js +46 -0
- package/lib/tools.js +341 -0
- package/lib/types.js +7 -0
- package/locale/en.json +6 -0
- package/locale/zh.json +6 -0
- package/package.json +87 -4
package/LICENSE
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 dsh-notebook contributors
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
22
|
+
|
|
23
|
+
The bundled icons are drawn from Lucide (https://lucide.dev), ISC licensed.
|
package/README.md
CHANGED
|
@@ -1,3 +1,96 @@
|
|
|
1
|
-
#
|
|
1
|
+
# 笔记本 (Notebook)
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
DeepSeek Harness(DSH)插件:**工作区里的 markdown 笔记本** —— 目录树、所见即所得编辑、自动保存,右侧嵌着 AI 对话。
|
|
4
|
+
|
|
5
|
+
- **Host 半边**:一个认证过的 JSON 控制面(读树、读写文件、建文件/目录、打开资源管理器、写工作区 README)。
|
|
6
|
+
- **Client 半边**:侧边栏入口 + 三栏面板(目录 · 文档 · 对话)。
|
|
7
|
+
- **没有工具、没有 skill、没有渲染管线**:面板编辑的就是工作区里的真实文件,模型用自己的 `read`/`write` 工具读写同一批文件。
|
|
8
|
+
|
|
9
|
+
## 安装(npm)
|
|
10
|
+
|
|
11
|
+
发布到 npm 后,在 DSH 里安装这个 bundle:
|
|
12
|
+
|
|
13
|
+
```text
|
|
14
|
+
安装 @zmskco/dsh-notebook 这个插件
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
(等价于让插件管理把这个包加进 profile 的依赖与 bundle 列表。)要求:DSH `^0.2.2-alpha.2`、Node `>=20`,声明在 `package.json` 的 `engines` 里,版本不符会被管理工具拒绝安装。装好后侧边栏出现「笔记本」。
|
|
18
|
+
|
|
19
|
+
## 功能
|
|
20
|
+
|
|
21
|
+
| 区域 | 用法 |
|
|
22
|
+
| --- | --- |
|
|
23
|
+
| 目录区(左) | 工作区文件树:点文件夹展开/折叠,点文件在中间打开;行首是文件夹/文件图标 |
|
|
24
|
+
| 文档区(中) | 默认所见即所得;`写作` / `源码` 两个按钮切换;字数与保存状态在右端 |
|
|
25
|
+
| 对话区(右) | 当前会话的对话;可隐藏(标题行最右端),隐藏只是不绘制,不卸载 |
|
|
26
|
+
|
|
27
|
+
- **两个新建图标 + 刷新 + 打开资源管理器**在目录列标题行右端,紧挨对话开关:`new-dir` / `new-file` / `refresh` / `reveal`。
|
|
28
|
+
- 新建是**就地命名**:点图标后目标目录里出现一行空名字,回车创建;空名字回车或 Esc 取消;输入法组字时回车不误触发。
|
|
29
|
+
- **文件名就是输入的名字,不补 `.md`**:输「第一章」得到 `第一章`;输「素材.md」得到 `素材.md`。重名时在扩展名前加序号(`名-2.md`)。
|
|
30
|
+
- **首次打开写一份 `README.md` 到工作区根目录**(`op=ensure-readme`),内容固定,且**只写不覆盖**。
|
|
31
|
+
- **排版**:字体 `黑 / 宋 / 霞 / 阿`(本机字体栈,不打包字体文件)、字号 13–24、纸色 `简白 / 雅致 / 黑夜 / 绿荫`——**纸色作用于整个面板**(左栏、编辑区、对话区同一张纸),默认简白。
|
|
32
|
+
- **编辑器**:ProseMirror 内核;markdown ↔ 文档模型双向转换,schema 表达不了的块(front matter、表格)作为 raw 块逐字保留;**文件里单个换行在页面上就是换行**(写回为行尾两空格 + 换行)。
|
|
33
|
+
- **自动保存**:停笔 900ms 写盘,`Ctrl/Cmd+S` 立即保存;切换文件先把当前缓冲写掉。**没有保存按钮**。
|
|
34
|
+
- **目录树**:`node_modules` 与点开头条目不列出;大目录有 2000 条上限。
|
|
35
|
+
|
|
36
|
+
## 树根与权限
|
|
37
|
+
|
|
38
|
+
**树根 = 调用方 Session 的 `header.cwd`**,也就是操作者打开的工作区:
|
|
39
|
+
|
|
40
|
+
| 规则 | 触发条件 | 结果 |
|
|
41
|
+
| --- | --- | --- |
|
|
42
|
+
| `override` | profile 行里配了 `rootDir` | 用该目录 |
|
|
43
|
+
| `workspace` | 有 Session 且未配 `rootDir` | 该 Session 的工作区 |
|
|
44
|
+
| `fallback` | 无 Session、无 `rootDir` | 部署写边界,否则 `<DSH_HOME>/glimmer` |
|
|
45
|
+
|
|
46
|
+
每次调用都从调用方 Session 解析,所以写入天然落在该 Session 沙箱已允许的目录里;写盘带 `{ mode, workspaceRoot }` 盖章。`op=focus` 把会话工作目录对齐到同一目录,让模型的相对路径与面板一致。
|
|
47
|
+
|
|
48
|
+
## 配置
|
|
49
|
+
|
|
50
|
+
`cordis.patch.yml` 的 `notebook` 行只有一个字段:
|
|
51
|
+
|
|
52
|
+
| 字段 | 默认 | 说明 |
|
|
53
|
+
| --- | --- | --- |
|
|
54
|
+
| `rootDir` | `null` | 面板的根目录;绝对路径,或相对工作区边界的相对路径。不设则跟随工作区 |
|
|
55
|
+
|
|
56
|
+
## HTTP 控制面
|
|
57
|
+
|
|
58
|
+
所有操作走 `/api/notebook?op=<动作>`,继承 Connection 的 Host/Origin 校验与浏览器认证。
|
|
59
|
+
|
|
60
|
+
| `op` | 参数 | 说明 |
|
|
61
|
+
| --- | --- | --- |
|
|
62
|
+
| `state` | — | 根目录、选择规则、沙箱报告 |
|
|
63
|
+
| `files` | `project=''` | 树的平铺清单(目录 + 文件) |
|
|
64
|
+
| `file` | `project=''`, `path` | 读一个文本文件 |
|
|
65
|
+
| `save-file` | `project=''`, `path`, `content` | 写一个文本文件 |
|
|
66
|
+
| `create-dir` | `project=''`, `name`, `dir` | 建目录(名字带分隔符 400,重名 409) |
|
|
67
|
+
| `create-file` | `project=''`, `title`, `dir` | 用输入的名字原样建文件;散文名带 `# 标题` |
|
|
68
|
+
| `focus` | `project=''` | 把调用方会话的工作目录切到工作区 |
|
|
69
|
+
| `reveal` | — | 用系统文件管理器打开工作区;`dryRun` 只回答会启动什么命令 |
|
|
70
|
+
| `ensure-readme` | — | 工作区 `README.md`:不存在则写(201),已存在则 `created:false`(200) |
|
|
71
|
+
|
|
72
|
+
`project` 只接受空串(工作区本身);故事/分镜/设定集相关的操作在这次简化中全部移除。
|
|
73
|
+
|
|
74
|
+
## 开发
|
|
75
|
+
|
|
76
|
+
```powershell
|
|
77
|
+
pnpm install
|
|
78
|
+
pnpm run build # host(tsc) + client(tsdown) + 产物契约检查
|
|
79
|
+
pnpm test # 类型检查 + 沙箱 + Host 冒烟
|
|
80
|
+
npm pack --dry-run # 看 tarball 内容
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
- `scripts/check-client.mjs`:产物是 lazy-CJS(`__ModuleLoader__.load`,只用 `react` 外部);槽位注册、字典、树、布局、字体/纸色、编辑器往返、图标与样式契约、以及「故事机制零残留」。
|
|
84
|
+
- `scripts/smoke-host.mjs`:不用 DSH 进程即可驱动整个控制面(40 项断言):建文件/目录、读写、路径逃逸、README、reveal、focus、写边界盖章。
|
|
85
|
+
- `scripts/check-sandbox.mjs`:写边界报告。
|
|
86
|
+
|
|
87
|
+
## 限制
|
|
88
|
+
|
|
89
|
+
- markdown 是子集:嵌套列表、HTML 块、引用式链接、脚注按普通文字处理;表格与 front matter 作为 raw 块保存,不在文档视图里做表格编辑。
|
|
90
|
+
- 不渲染 mermaid 之类的文本作图。
|
|
91
|
+
- 字体不打包,用本机字体栈;没装会退到同类系统字体。
|
|
92
|
+
- 重命名与删除请用系统资源管理器(标题行的「打开」)或让模型操作。
|
|
93
|
+
|
|
94
|
+
## 许可
|
|
95
|
+
|
|
96
|
+
MIT。内置图标来自 [Lucide](https://lucide.dev)(ISC)。
|
package/cordis.patch.yml
ADDED
package/icon.svg
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24" fill="none"
|
|
2
|
+
stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true">
|
|
3
|
+
<path d="M2 6h4" />
|
|
4
|
+
<path d="M2 10h4" />
|
|
5
|
+
<path d="M2 14h4" />
|
|
6
|
+
<path d="M2 18h4" />
|
|
7
|
+
<rect width="16" height="20" x="4" y="2" rx="2" />
|
|
8
|
+
<path d="M16 2v20" />
|
|
9
|
+
</svg>
|