Files
marqdo/doc/design/examples-and-tests.md
T
cflmyandCursor bfb10d172b feat(markup): adopt v0.3 as sole mapping (** code, * return)
Make prose-unified Markup the only runtime: bold segments are executable,
italic is return, params can be inferred from body/prose, with no v0.2 dual
mode. Migrate lib and structure/keywords golds; gate on tests/markup-v03.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-09-13 20:38:53 +08:00

2.4 KiB
Raw Blame History

示例与测试布局

状态 已定
日期 2026-08-07
原则 夹具即金样例:tests/{structure,keywords,errors}/**/*.mq.md 由 cargo test / CI 跑通;marqdo view tests 也可浏览

1. 目录

只保留 tests/,用子目录区分类别(不再另设 examples/):

tests/
  README.md
  gold.rs                   # 集成测试入口
  structure/                # 代码基础结构(Markup 架构 · v0.2)
    …
  keywords/                 # 关键字与内置名
    …
  markup-v03/               # Markup 映射 v0.3 草案金样例(实现前 ignore)
    README.md
    inc-prose.mq.md
    …
  ext/
    …
  errors/                   # 期望失败(诊断文案稳定后再加金样例)
    …

面向访客的可执行介绍在 public/(无 errors/),见 user-site.md。
开发设计文稿在 doc/(单数)。


2. 分类职责

类别 测什么 不测什么
structure #/##、形参 +、1. 分支、- 循环、表、导入、点号路径 / use、位置/具名实参 关键字边角
keywords True/False/None、and/or/not、print/input 约定 复杂控制流(可极简)
markup-v03 v0.3:叙述声明、粗体代码、斜体返回、升参、空返回、双调用面(见 markdown-mapping-v0.3.md) 在 --markup v0.3 落地前 #[ignore]
errors 未定义名、实参错误、语法错误的诊断 成功路径

未单独建夹、但应覆盖的其它测试(src/** 单测或日后 tests/runtime/):

  • 流水线调试:--dump-lines / --dump-ast / --trace-eval
  • CLI:默认 index.mq.md、退出码
  • view:目录扫描、单文件页、执行区(见 view.md)
  • 模块图:循环导入拒绝;errors/ns-instance-method(实例方法路径)
  • ext live:ext/agent-run-live(需 .env + libagent)

3. 金样例约定

每个可执行 .mq.md 在 tests/gold.rs 登记期望 stdout。
errors/ 内文件登记期望 stderr 子串与非零退出码。


4. 与 view / public 的关系

  • marqdo view tests:开发者浏览金样例(含 errors)。
  • marqdo view public:用户文档站源;不要把 tests/errors 编进 public/。