3.3 KiB
Marqdo CLI — Agent / Contributor Operating Rules
Start here: read docs/DEVELOPMENT_BLUEPRINT.md before proposing code. It is the project architecture baseline. Then read the relevant spec/ files and conformance fixtures. Do not assume any current implementation or legacy Marqdo syntax is authoritative.
Non-negotiable architectural constraints
- New independent language/toolchain. Do not silently modify
cflmy/marqdoor claim compatibility with its syntax, package format or plugin ABI. - CommonMark/GFM/Math AST is the sole Markdown syntax structure. Do not implement a second Markdown parser or use regex heuristics to decide whether text is executable.
- Executable roles are based on AST type and valid structural context:
Strongexecution,Emphreturn, ordered list branch, bullet list loop, blockquote invocation, heading scoping. Invalid executable shapes are compile errors, not ordinary prose fallbacks. - Prose and executable nodes may mix freely in one function/branch/loop body. Prose itself never causes an action.
- Marqdo is executed by its own Rust interpreter. Python/Node are optional foreign kernels, never the official compiler target.
- Code fences and math expressions create inert native
CodeandFormulavalues. Evaluation requires explicit calls and relevant capability grants. - YAML project/dependency and frontmatter imports must be explicit. Markdown Links are static references, not implicit calls or imports.
- Third-party plugins require a versioned C ABI and SDK. A C ABI is not a sandbox. Default third-party execution must be isolated; in-process native loading requires explicit trust.
- Side effects go through
CapabilityHost; do not invent host bypasses for tests, plugins, math or foreign kernels.checkandinspectcannot execute untrusted project code. - Language semantics, package format, ABI, authorization defaults or public CLI behavior changes require an ADR + tests + spec updates.
Development workflow
- Identify the affected rule and cite the section of
docs/DEVELOPMENT_BLUEPRINT.md. - Add a small
.mq.mdpositive/negative conformance fixture and define the expected Markdown AST and execution IR. - Implement only the smallest module that satisfies this fixture. Keep Markdown parser, semantic mapper, runtime and host separated.
- Run formatting, clippy, unit tests, gold tests and relevant security/ABI compatibility tests.
- Write the tradeoff and state of completion in the PR. Never say a feature is finished because a design example looks executable.
Unresolved design topics
The blueprint's section 17 lists issues that need separate Accepted ADRs (e.g. emphasis conflicts, parameter inference ambiguity, plugin memory ownership, strict platform isolation). Use its proposed baseline for prototypes, but do not freeze these topics through undocumented code.
Priorities
P0 AST/grammar contracts → P1 independent interpreter → P2 references/CLI → P3 package/env → P4 sandbox → P5 math/foreign → P6 plugin ABI/SDK → P7 performance/release. Design the Host security boundary and ABI early, even if full implementation arrives later.
Never translate Marqdo into Python as the official execution method; never silently downgrade an invalid execution node to prose or a requested strict sandbox to an unrestricted process.