forked from EduCraft/curriculum-project-hub
chore(spec+checker): cleanup pass — trim docs, reorg Courseware, covers-as-data, fold DanglingReference (ADR-0012)
Spec母本噪音清理 + 一处 spec↔impl 对齐 + 一处契约自洽修正。 Part A — spec doc 瘦身:每条 doc 收到"语义点 + 标签 + ADR ref + 承载性 why", 把跨文件复读的方法论(element-kind 开放性对比、likec4 画不出、分歧点测试)上移到 module header。OPEN 框架保持清晰(RunState/Capability 完整性仍明示须 surface)。 Part B — Courseware/ 由 10 文件平铺重组为 Model/ Export/ Check/ Open/ 四子命名空间 (namespace Spec.Courseware 不变,零引用改动)+ 四个子 aggregator。lake build 绿(24 jobs)。 Part C — 渲染覆盖落为数据(ADR-0011 对齐):去掉 cph-check 里硬编码的 COVERED_TARGETS,改读 TargetConfig.covers。cph-model 新增 covers: Option<Vec<String>> (None=未声明,由 cph-check 默认为全部 known kinds;显式 [] 表示不覆盖任何 kind)。 新增 3 个覆盖行为测试。 ADR-0012 — DanglingReference 退役(诊断 7→6 类):其两种情形(未解析 @ref、越界/缺失 相对 import)都是 typst 编译期失败,归 typstCompile。同步移除 Oracle.refsResolve (被 compiles 蕴含),Legal 少一个合取项。impl 删去从未被发射的 DiagCode::DanglingReference, 闭合 named-but-unemitted 的 spec↔impl 缝。ADR-0010 加修订指针。 OPEN 点(RunState/Capability 完整性、QuestionBank、Course)按既定纪律保持 OPEN,本次 只改善其框架措辞,不决策。 验证:spec lake build 绿;cargo test 全绿(含新增覆盖测试);clippy 静默; TH-141 check 0 errors/0 warnings 无回归。 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
+15
-29
@@ -1,35 +1,21 @@
|
||||
import Spec.Courseware.Primitives
|
||||
import Spec.Courseware.RichContent
|
||||
import Spec.Courseware.Artifact
|
||||
import Spec.Courseware.Element
|
||||
import Spec.Courseware.Lesson
|
||||
import Spec.Courseware.Render
|
||||
import Spec.Courseware.Diagnostic
|
||||
import Spec.Courseware.Pipeline
|
||||
import Spec.Courseware.QuestionBank
|
||||
import Spec.Courseware.Course
|
||||
import Spec.Courseware.Model
|
||||
import Spec.Courseware.Export
|
||||
import Spec.Courseware.Check
|
||||
import Spec.Courseware.Open
|
||||
|
||||
/-!
|
||||
# Courseware —— 产品层契约(课程工程文件)
|
||||
|
||||
护城河:课程"工程文件"的语义母本与合法性规则。决策出处 ADR-0005 / 0006 / 0007 / 0008
|
||||
/ 0009 / 0010 / 0011。
|
||||
护城河:课程"工程文件"的语义母本与合法性规则。决策出处 ADR-0005..0011。按四组组织:
|
||||
|
||||
已填实(PINNED):
|
||||
- `Primitives` —— 基元载体(表示留给实现;schema 形态见 ADR-0006)。
|
||||
- `RichContent` —— 富内容 = 带虚拟路径的 typst 源(ADR-0006 的 prose 母本)。
|
||||
- `Artifact` —— export 产物(带字段 ADT:`singleFile filepath` / `fileTree root outputs`),
|
||||
target 值的一部分(ADR-0009/0011)。
|
||||
- `Element` —— kind 标签 + 依赖 schema 的数据。
|
||||
- `Lesson` —— element 的有序序列(序载教学语义、不建模时长)。
|
||||
- `Render` —— export target = artifact + 有序 typed steps:`TargetSpec` 携 `artifact` +
|
||||
`steps : List Step`(`typstCompile template` / `shell run`)+ 覆盖声明 `covers`;
|
||||
`RenderConfig.covers` 判定(ADR-0009/0011,修订 ADR-0005)。RenderRule 载荷已废止。
|
||||
- `Diagnostic` —— Severity + 7 类诊断的含义与级别 + **合法 lesson = 无 error 级诊断**;
|
||||
模型外设施诊断以抽象谓词 + `Oracle` 实现边界表示(ADR-0010)。
|
||||
- `Pipeline` —— 检查管线的 5 阶段、执行序、compile 门控(ADR-0010)。
|
||||
|
||||
留白骨架(核心关系 OPEN,已 surface 不臆造):
|
||||
- `QuestionBank` —— 题库与 element 的关系(引用 vs 内联)。
|
||||
- `Course` —— course = lesson 编排的规则。
|
||||
- **`Model`** —— 工程文件的内容模型:基元 `Primitives`、富内容 `RichContent`、原子
|
||||
单位 `Element`、单节课 `Lesson`(element 的有序序列)。
|
||||
- **`Export`** —— export target = artifact + 有序 typed steps:产物 ADT `Artifact`
|
||||
(`singleFile` / `fileTree`),build 规格 `TargetSpec`(artifact + steps + 覆盖声明
|
||||
`covers`)与 `RenderConfig`。
|
||||
- **`Check`** —— checker 语义:`Severity` + 6 类诊断 + **合法 lesson = 无 error 级
|
||||
诊断**(模型外设施诊断以抽象谓词 + `Oracle` 表示);检查管线的 5 阶段、序、compile
|
||||
门控。
|
||||
- **`Open`** —— 留白骨架(核心关系 OPEN,已 surface 不臆造):题库 `QuestionBank`、
|
||||
课程编排 `Course`。
|
||||
-/
|
||||
|
||||
Reference in New Issue
Block a user