检查规则
检查文档中可能的不规范问题。
用法
bash
tuack-ng doc check
tuack-ng doc check --explain latex规则列表
| 规则 | 说明 | 自动修复 |
|---|---|---|
invisible | 检测不可见 Unicode 字符（零宽空格、BOM、软连字符、方向标记等） | 是 |
autocorrect | 检测中英文之间的空格和标点符号问题 | 是 |
samples-not-found | 检查 sample.text(N) / sample.file(N) 中的 ID 是否有效，对应的样例文件是否存在 | 否 |
samples-too-large | 检查 sample.text 引用的文件是否超过限制（80 行 / 40 列 / 10 KB），超过应改用 sample.file | 是 |
samples-should-be-external | 检查题面中是否有内联样例代码块，应提取为外置文件 | 是 |
latex | 检测 LaTeX 公式问题：未转义的函数名、运算符（<=、>=、...、*、/）、不带反斜杠的 mod、公式中的中文、大数字、首尾空格 | 否 |
html | 检测 Markdown 中的内联 HTML 和 HTML 块（通常不应使用） | 否 |
报告格式
每条检查结果包含：
- 文件路径
- 行号和列号（如有）
- 严重级别（warning / error）
- 描述信息
说明
由于当前的架构限制，部分报告没有行号与列号。
未来我们将解决这个问题。