feat(docs,scripts,build): 用 docfx 搭文档站并发布到 GitHub Pages，版本号收口成脚本迭代
文档站（`docs/` 就是 docfx 项目，发布在 https://lovechengke.github.io/ClassHelper/）： - 四章 + 常见问题 + 完整参考，共 44 页：快速上手（8 页）/ 应用帮助（10 页）/ 管理运维（6 页）/ 开发文档（11 页）。信息架构照 ClassIsland 文档站来： 顶栏分章、左侧章节导航、右侧本页目录、上一页 / 下一页、站内搜索、深色主题跟随系统； - 自定义模板覆盖（`templates/classhelper/`）：把 docfx modern 模板那套英文 UI 文案 （In this article / Improve this doc / Next…）换成中文，补 GitHub 入口与版本徽标， 并加一层只调排版与配色的 `public/main.css`（不动 DOM 结构）； - 站点顶栏的版本徽标取自根 `package.json`（`docs/build.mjs` 用 `--metadata` 注入）， 不在文档里写第二份 —— 否则一定漂； - 404 页单独生成：GitHub Pages 的项目页挂在 `/<仓库名>/` 子路径下，而浏览器是按**被请求的路径** 解析页面里的相对链接的，所以 `<base>` 必须钉到站点根，由 `build.mjs`（本地 `./`）与 workflow（CI 传 `/<仓库名>/`）分别注入； - 构建前清空 `_site`：docfx 只覆盖不清理，删掉或改名的页面会以旧文件留在目录里， 而 Pages 上传的是整个目录。 版本迭代（**每一次 releases，不是每一次提交**）： - 新增 `scripts/version.mjs`。这个仓库里同一个版本号散在 **10 个文件**里（5 份 `package.json`、 `deploy/package.runtime.json`、两个 compose 的镜像 tag、插件 `manifest.yml`、以及插件 C# 里的 `PluginVersion` 常量），手工改必然漏一处，而漏掉的那处**不会报错**，只在某个不常走的分支上 表现为"版本号对不上"。现在收口成两条命令：`pnpm version:check`（逐处比对，不一致 exit 1） 与 `pnpm version:bump patch|minor|major`（一次改写全部 10 处，任何一处匹配不到或匹配到多处 就直接失败退出，不做尽力而为的部分改写）； - `AGENTS.md` 新增 §4.4「版本迭代（每一次 releases，不是每一次提交）」：写清版本号落在哪 10 处、 完整发布命令序列（体检 → 验收 → `dist:all` → 哈希清单 → 推 master → `gh release create` → Linux 包由 CI 合并哈希行），以及"已发布的版本号不要复用"的理由。 其它： - `.github/workflows/docs.yml`：推 master（`docs/**` / `package.json` / workflow 自身有变）即构建并 部署到 Pages；构建带 `--check`，把 docfx 的警告当错误 —— 最常见的警告是"某个 `.md` 没被任何 `toc.yml` 引用"，那种页面有内容但没有侧边栏，属于必须修掉的疏漏； - docs 目录重组后的引用同步：`production` / `mysql` / `linux-deploy` / `winisland-design-tokens` 移到新位置后，AGENTS.md、`deploy/`、`scripts/`、客户端源码注释里的路径引用一并更新； - 文档站只发布 `docs/` 这一棵树，页面里指向树外的相对链接（`../AGENTS.md` 等）改成 GitHub 绝对 URL， 否则上线全是 404； - 图标派生清单补上文档站模板里的 `logo.png` 与 `favicon.png`（`pnpm icons` 一并生成， 仍然只有一个图形源 `build/classhelper.{png,ico}`）； - `docs/_site` 进 `.gitignore` / `.prettierignore` 与 ESLint ignores； - 根脚本补 `version:check` / `version:bump` / `docs:build` / `docs:serve` / `docs:check`。
This commit is contained in:
LoveChengke committed
1 parent
5b002a4f0b
commit
19c2aa07b2
61 files changed
+4761
-12
No files matched your search
@@ -0,0 +1,146 @@
|
||||
---
|
||||
title: ClassIsland 插件
|
||||
description: 联动插件的契约、镜像为什么要带节次时间、上课时段暂存，以及部署与调试。
|
||||
---
|
||||
|
||||
# ClassIsland 插件
|
||||
|
||||
源码在 `packages/classisland-plugin/`，是一个 **.NET 8 / C#** 的 ClassIsland 插件
|
||||
（ClassIsland 插件 API 2.0）。它**独立于 pnpm workspace**，不参与 `pnpm install`。
|
||||
|
||||
## 三条链路
|
||||
|
||||
```
|
||||
ClassIsland（教室机器）
|
||||
│ ① 上报：状态 + 课表 + 节次时间（每次上报顺带取回一条待弹提醒）
|
||||
▼
|
||||
/api/integrations/classisland/report ← X-ClassIsland-Token（设备令牌，非 JWT）
|
||||
│
|
||||
│ ② 下发：老师在 Web 端发提醒 → 落库 → 插件下次上报时取回 → ClassIsland 全屏弹出 → ack
|
||||
▼
|
||||
/api/integrations/classisland/pending、/ack
|
||||
|
||||
│ ③ 镜像（可选）：服务端把本班课表下发，插件在 ClassIsland 里新建一份档案课表
|
||||
▼
|
||||
/api/integrations/classisland/class-plan
|
||||
```
|
||||
|
||||
## 为什么走 HTTP 而不是 IPC
|
||||
|
||||
ClassIsland 的跨进程 IPC 数据质量不足以还原课表。插件内部**直接读**
|
||||
`ILessonsService`（课程状态）与 `IProfileService`（档案课表）最准。
|
||||
|
||||
与后端之间用「**上报即拉取**」：每次上报的返回值里顺带带一条待弹出的提醒 ——
|
||||
插件因此**不需要 WebSocket 依赖**，故障面更小，而且**上报间隔本身就是心跳**。
|
||||
|
||||
提醒是**轮询取回**的（默认最多 10 秒延迟，设置页「提醒轮询间隔」可调到 5 秒）。
|
||||
|
||||
## 设备令牌
|
||||
|
||||
- 令牌是**设备级**的，不是用户级；
|
||||
- 插件在本机保存明文，服务端只存 **sha256** 与一个前缀提示（`chci_xxxxxxxx`）用于人眼识别；
|
||||
- 同一班级下按 `deviceKey`（机器码）唯一 —— 插件重装后带同一 `deviceKey` 会**自动重绑**到原记录，
|
||||
不会在设备列表里堆重复项；
|
||||
- 关闭设备的「启用」开关后，该设备的上报与下发一律 403。
|
||||
|
||||
## 提醒的排队规则
|
||||
|
||||
| 提醒类型 | 上课时段 | 下课 / 放学 |
|
||||
| ------------------------------------------------------ | ---------------------------- | ----------- |
|
||||
| 通知类（`kind=notification`：通知发布页 / 联动页下发） | **暂存不弹** | 自动补弹 |
|
||||
| 主动通知：紧急提醒、**叫人**（`kind=call`） | **立刻弹**（老师正在等学生） | 立刻弹 |
|
||||
|
||||
插件侧的实现在 `ClassHelperNotificationProvider`（`_deferred` + `FlushDeferred`，订阅课程事件）；
|
||||
客户端侧的实现在 `renderer/island/bridge.ts`。**改这条规则要两端一起改。**
|
||||
|
||||
暂存期间**不回执**，所以服务端会一直保留着待提醒；`ClassIslandPush.expiresAt` 到期后不再补发
|
||||
（避免学生几天后突然弹出旧提醒）。
|
||||
|
||||
## 镜像：为什么必须带 `startTime` / `endTime`
|
||||
|
||||
ClassIsland 的 `ClassPlan.Classes[i]` **强制与时间表里第 i 个 `TimeType == 0`（上课）的时间点对齐**。
|
||||
|
||||
所以镜像下发时，每一条课目都要带上自己的 `startTime` / `endTime`。
|
||||
|
||||
> **少一个时间点，整份课表就会错位** —— 而且表现为"课表看着有内容、每节课都对不上"，
|
||||
> 极难排查。这是插件契约里最容易踩的坑。
|
||||
|
||||
另外镜像进 ClassIsland 的课表还要**带课间**：每两节之间补一段（上一节下课 → 下一节上课），
|
||||
**最后一节之后不补**（放学）。实现见 `ClassPlanWriter.BuildTimeLayout`（自己按课目时间算），
|
||||
服务端合成节次时间表用的是同一口径。
|
||||
|
||||
## 上报课表：单向还是双向
|
||||
|
||||
**双向对齐**。插件每次全量上报时，服务端只清理「`source='classisland'` 且本次未再上报」的行：
|
||||
|
||||
- 老师在 ClassIsland 里删掉 / 挪动一节 → 小助手这边跟着同步；
|
||||
- 老师在小助手这边手排的课 → **一律不删**。
|
||||
|
||||
merge 的去重键是「星期 + 开始时间 + 单双周」。导入时**不要覆盖 `weekStart` / `weekEnd`** ——
|
||||
插件上报契约里没有周次范围，硬写"整学期"会把老师设的「第 1~10 周」抹掉。
|
||||
|
||||
## 单双周的映射
|
||||
|
||||
ClassIsland 的 `WeekCountDiv` / `WeekCountDivTotal` ⇄ 本项目的 `ALL / ODD / EVEN`，
|
||||
走 `@classhelper/shared` 的 `weekParityFromDiv` / `weekDivFromParity` ——
|
||||
**服务端与插件共用同一份语义**，两边不会各算各的。
|
||||
|
||||
## 代理：本地地址强制直连
|
||||
|
||||
`ClassHelperClient` 里有一个 `LocalAwareProxy`：对本地 / 内网地址**强制直连**，
|
||||
不走系统代理。
|
||||
|
||||
原因：教室机器上如果开了系统代理，填好令牌后表现为"立刻 HTTP 404"（其实是代理返回的错误页）。
|
||||
`pnpm verify:classisland-plugin` 有 4 项断言盯着这段逻辑，别删。
|
||||
|
||||
## 构建、打包与验收
|
||||
|
||||
```bash
|
||||
pnpm build:classisland-plugin # 编译（.NET 8；缓存与临时目录自动指到仓库内 .cache/）
|
||||
pnpm dist:classisland-plugin # 打包 .cipx 并归集到 releases/classisland-plugin/<版本>/
|
||||
pnpm verify:classisland-plugin # 静态契约校验（不需要 .NET，不需要服务端）
|
||||
```
|
||||
|
||||
`verify:classisland-plugin` 会逐项校验：清单一致性、注册完整性、
|
||||
**C# DTO ↔ 服务端 zod 与路由的字段对齐**，以及已修复坑的护栏。
|
||||
|
||||
### 那个预期内的编译警告
|
||||
|
||||
全量编译会有 **1 个警告 `AVLN3001`**：设置页只有 DI 构造函数、没有公开无参构造。
|
||||
本插件走的是编译期 XAML + ClassIsland 的 DI 实例化，**加个无参构造反而会把 DI 弄坏**。
|
||||
别为了消警告去改它。
|
||||
|
||||
## 部署到教室机器
|
||||
|
||||
```powershell
|
||||
# 1) 完全退出 ClassIsland（它会锁住 DLL）
|
||||
Get-Process ClassIsland.Desktop | Stop-Process -Force
|
||||
# 2) 覆盖插件 DLL（**不要覆盖 Settings.json**，那里存着服务器地址与设备令牌）
|
||||
Copy-Item packages\classisland-plugin\bin\Release\ClassHelper.ClassIslandPlugin.dll `
|
||||
D:\Classisland\data\Plugins\classhelper.classisland.bridge\ -Force
|
||||
# 3) 重新启动
|
||||
Start-Process D:\Classisland\ClassIsland.exe -WorkingDirectory D:\Classisland
|
||||
```
|
||||
|
||||
改配置要在 **ClassIsland 退出时**改：运行中改会被内存里的副本随时回写覆盖。
|
||||
|
||||
### 读日志要用 GBK
|
||||
|
||||
.NET 的控制台输出是**系统 ANSI（GBK）**编码。用 UTF-8 读会变成乱码，
|
||||
**中文关键字一条都搜不到**（只能搜到 ASCII 的类名）：
|
||||
|
||||
```powershell
|
||||
[System.IO.File]::ReadAllLines($path, [System.Text.Encoding]::GetEncoding(936))
|
||||
```
|
||||
|
||||
日志文件被运行中的进程占用时，先 `Copy-Item` 一份再读。
|
||||
|
||||
## 真机验收链路
|
||||
|
||||
`pnpm verify:classisland`（需要后端在跑）会真的走一遍：设备令牌 → 上报 → 提醒下发与回执 →
|
||||
镜像契约 → 幽灵行清理。
|
||||
|
||||
> 这个脚本开头会先**抽干本班的历史积压提醒**。因为待提醒接口是「本班全部未确认提醒，
|
||||
> 按时间升序取前 20 条」，而其他冒烟会真的往演示班发通知 —— 攒够 20 条之后，
|
||||
> 本脚本刚发的提醒会被挤出窗口，表现为"待提醒里找不到刚发的那条"，跟代码对不对毫无关系。
|
||||
> **别把那个 drain 删掉。**
|
||||
Reference in new issue
Block a user