DSH VERIFY KIT · dsh-outline-lint
文档结构检查清单
它决定一件事:这份文档在结构上是否可审。
检查规则
| 规则 | 判定 |
|---|---|
no-title | 没有一级标题 → error |
multiple-h1 | 多个一级标题 → warn(只有文章标题该是一级) |
heading-jump | h1 下面直接 h4 → warn,提示层级丢失 |
no-conclusion | 没有「结论/摘要」标题、开头也没有「结论:」→ error |
no-reproduction | 没有复现章节、也没有任何可运行命令 → error |
用法
npx outline-lint report.md --jsonnpx outline-lint report.md --warnings-fail
真实输入输出
输入
# 数据管线报告
#### 处理流程
原始数据经清洗后入库。$ outline-lint report-outline.md
warn heading-jump line 3: "处理流程" is h4 directly under h1, which reads as a lost level
error no-conclusion no conclusion before the body: add a heading matching 结论/摘要 or open the first paragraph with 结论:
error no-reproduction nothing a reader can run: add a 复现 section or a fenced command
fail: 2 errors, 1 warnings
出口码:1。输出为真实 CLI 运行的逐字结果,由测试与工具保持同步。
出口码:0 干净、1 有发现、2 用法或读文件错误。--json 输出机器可读结果,--warnings-fail 让警告也算失败。DSH 内同样的函数在 POST /outline-lint/api({"text":"…"} 或 {"path":"…"}),面板与 CI 调同一实现,不可能不一致。
这是清单,不是专业人士。每条发现都是文件里可判定的结构缺陷,带行号或路径;它从不说「内容好不好」。
判定从文件来,不做任何模型调用:结论先行匹配 结论/摘要/summary/tl;dr,复现匹配章节名或 node/npm/python/git/docker 等命令行。 · dsh-verify-kit 全部五个检查