Files
classhelper-island-refactor…/README.md
T

65 lines
5.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# ClassIsland / ClassHelper 灵动岛提示词套件
本仓库是「以 ClassIsland 为基准、重构 ClassHelper 灵动岛」的完整提示词交付物与相关调研记录。内容面向 **ChatGPT 等代码生成模型**:既可整体投喂,也可按分卷/逐章投喂。
> 所有内容均由静态源码分析生成,**不包含** ClassIsland 或 ClassHelper 的上游代码;仓库中不含 `repos/` 克隆、构建产物或运行时依赖。分析过程中没有构建、运行或截图任何桌面程序。
## 一、仓库内容
| 路径 | 说明 |
|---|---|
| `ClassHelper灵动岛重构-给ChatGPT的完整提示词.md` | **主交付物(重构版)**:在 ClassHelper 现有仓库内重构灵动岛的完整提示词;14 个 part(0–13),约 30 万字符,约 12.3 万 tokens |
| `out/投喂指南-重构版.md` | 重构版投喂指南:准备、分卷方案、token 估算、追问话术 |
| `out/vol1-…` ~ `out/vol5-…` | 重构版 5 个分卷(适合 32k–128k 上下文模型) |
| `out/refactor-sections/` | 重构版 14 个独立 part(逐章投喂) |
| `ClassIsland-给ChatGPT的完整提示词.md` | 上一轮产物:ClassIsland 全功能「从零实现」规格(约 20 万 tokens),含主界面/组件/课表/提醒/自动化/主题/设置/插件/数据/动画/验收等完整规格 |
| `out/投喂指南.md` | 上一轮产物的投喂指南 |
| `out/vol1-…` ~ `out/vol5-…`(旧五卷) | 上一轮产物的分卷 |
| `out/sections/` | 上一轮产物 20 个独立 part |
| `parts/` | 上一轮 20 个 part 源文件(01–19) |
| `parts-r/` | 本轮 14 个 part 源文件(00–13) |
| `analysis/` | 调研记录:两份总简报、一致性基线、各成员的已读文件/决策/未决项 |
| `scripts/` | 内部工具:分卷组装、质检、指南生成、一致性修补脚本(非运行时依赖) |
## 二、两份主提示词如何选择
1. **你的目标是「重构 ClassHelper 的灵动岛」** → 使用 `ClassHelper灵动岛重构-给ChatGPT的完整提示词.md`。它包含 ClassHelper 现状基线、文件级改造清单、`islandLayout.version=2` 迁移、ClassHelper 数据契约、编辑器/设置页重构、验收与里程碑。
2. **你的目标是「从零实现一个 ClassIsland 等价应用」(Electron + Vue 3)** → 使用 `ClassIsland-给ChatGPT的完整提示词.md`。
3. 两份冲突时,以重构版为准(它包含 ClassHelper 现状与迁移约束);ClassIsland 版仅作为补充的原版细节参考。
## 三、重构版要点(提示词已详细展开)
- 默认采用 ClassIsland 规格:`fixed` 在 `family='classisland'` 下重定义为 40px 信息行(默认日期 + 课程表、行内气泡、3px 进度条);旧「胶囊 + 详情卡」作为 `winisland` 兼容风格保留,老用户升级默认 `winisland`。
- `custom` 布局始终按 ClassIsland 规格重构,`family` 只影响 `fixed`。
- 消息/课程提醒/强提醒/天气/课件覆盖继续使用 ClassHelper 的服务端数据与业务规则。
- `islandLayout.version=2`:迁移先行、备份/回滚、幂等;旧 schemes/rows/nodes/外观全部保留。
- 动画表 84 条、组件 11+ 类、编辑模式/行设置/组件设置抽屉逐像素规格。
- 所有自动验证必须无头运行;`--visual` 才允许桌面截图/动画验收(详见提示词第 11、12 部分)。
## 四、使用建议
先读对应 `投喂指南`,按「五卷」或「逐章」投喂;给模型 ClassHelper 仓库作为代码上下文(重构版必须);开场要求模型先输出文件级计划、迁移方案与无头验证方案,再开始改代码。
## 五、来源与合规
- 行为与视觉基准:ClassIsland(GPL-3.0,https://github.com/ClassIsland/ClassIsland),仅作为静态分析对象,仓库不包含其源码/资源。
- 技术栈与现状基线:ClassHelper(https://github.com/LoveChengke/ClassHelper),仅作为静态分析对象,仓库不包含其源码/资源。
- 文中引用的 `packages/...:行号`、`repos/ClassIsland/...:行号` 是分析时的证据位置,不是本仓库的运行时依赖。
- 部分 FluentAvalonia 主题色值、Avalonia 缓动到贝塞尔曲线的换算不在上游仓库内,已在正文标注【推断】。
- 若将提示词用于再分发,请遵守上游项目的许可与商标要求;本仓库仅包含原创分析文本与规格描述。
## 六、生成与复现
- 汇总重构版:`node scripts/assemble-r.mjs --split`
- 汇总 ClassIsland 版:`node scripts/assemble.mjs --split`
- 机械质检:`node scripts/qc.mjs`、`node scripts/check-r.mjs`、`node scripts/checkfinal.mjs`
- 重新生成投喂指南:`node scripts/guide.mjs`
- 推送到 Gitea(令牌只从环境变量读取,不写入仓库):`GITEA_TOKEN=<token> node scripts/push-to-gitea.mjs`;等价 PowerShell:`powershell -ExecutionPolicy Bypass -File scripts/push-to-gitea.ps1`
- 这些脚本只做文本合并/统计与 Git 操作,不会构建或运行桌面应用。
## 七、已知限制
- 提示词长度较大(重构版约 12.3 万 tokens),请按指南分批投喂;不要指望小上下文模型一次吃下。
- 部分 ClassHelper 现状细节(`main/island.ts` 的行号区间、编辑器交互)以分析时源码为准,后续仓库演进可能导致行号漂移;以函数/符号名检索更可靠。
- ClassIsland 版本为分析时的 v2.1(master 分支);上游后续变化可能产生差异。