Documentation
¶
Overview ¶
Command m is the cross-engine M toolchain (the busybox; spec §1). This stage ships `m fmt` — the AST-preserving formatter over the m-parse substrate (spec §3.1) — alongside the shared clikit conventions (--output text|json, schema, deterministic errors). lint/lsp/test/coverage/watch land next.
Try:
m fmt routine.m # report whether it needs formatting m fmt --rules=canonical --write . # uppercase command keywords in place m fmt --rules=canonical --check . # CI gate: exit 3 if any file differs cat routine.m | m fmt --rules=canonical --stdin m schema | jq .
Directories
¶
| Path | Synopsis |
|---|---|
|
Package clikit is the shared CLI convention layer for the m-cli Go toolchain.
|
Package clikit is the shared CLI convention layer for the m-cli Go toolchain. |
|
internal
|
|
|
arch
Package arch implements the m/v waterline gates — the machine-checkable boundary between the engine-neutral `m` layer and the VistA-specific `v` layer (see docs/background/m-v-waterline-adr.md in the org `docs` repo).
|
Package arch implements the m/v waterline gates — the machine-checkable boundary between the engine-neutral `m` layer and the VistA-specific `v` layer (see docs/background/m-v-waterline-adr.md in the org `docs` repo). |
|
config
Package config loads m-cli's project-level configuration — the [lint.*] and fmt sections of a `.m-cli.toml` (preferred) or a `[tool.m-cli]` table in pyproject.toml.
|
Package config loads m-cli's project-level configuration — the [lint.*] and fmt sections of a `.m-cli.toml` (preferred) or a `[tool.m-cli]` table in pyproject.toml. |
|
dispatch
Package dispatch is the `m` busybox's sibling-binary dispatcher (spec §2.2, tracker [N12]).
|
Package dispatch is the `m` busybox's sibling-binary dispatcher (spec §2.2, tracker [N12]). |
|
engine
Package engine is the runtime adapter — the only engine-bound code in m-cli (spec §8).
|
Package engine is the runtime adapter — the only engine-bound code in m-cli (spec §8). |
|
flow
Package flow is m-cli's control-flow / dataflow infrastructure for the path-sensitive lint rules (spec §3.1; the Python tool's "Phase 7").
|
Package flow is m-cli's control-flow / dataflow infrastructure for the path-sensitive lint rules (spec §3.1; the Python tool's "Phase 7"). |
|
harness
Package harness is the host-side trigger/render client for the resident pure-M harness (design §3.1, spec §9).
|
Package harness is the host-side trigger/render client for the resident pure-M harness (design §3.1, spec §9). |
|
lint
Package lint is m-cli's M source linter.
|
Package lint is m-cli's M source linter. |
|
lsp
Package lsp is m-cli's Language Server (spec §3.1): LSP 3.x over stdio, reusing the lint and fmt engines so the editor shows exactly the diagnostics CI produces.
|
Package lsp is m-cli's Language Server (spec §3.1): LSP 3.x over stdio, reusing the lint and fmt engines so the editor shows exactly the diagnostics CI produces. |
|
mcov
Package mcov is m-cli's coverage runner (spec §3.1/§8).
|
Package mcov is m-cli's coverage runner (spec §3.1/§8). |
|
mfmt
Package mfmt is m-cli's AST-preserving M source formatter (spec §3.1).
|
Package mfmt is m-cli's AST-preserving M source formatter (spec §3.1). |
|
mtest
Package mtest is m-cli's test runner (spec §3.2): it discovers *TST.m suites, runs them through the Engine adapter, and parses the pure-M ^STDASSERT / TESTRUN output.
|
Package mtest is m-cli's test runner (spec §3.2): it discovers *TST.m suites, runs them through the Engine adapter, and parses the pure-M ^STDASSERT / TESTRUN output. |
|
watch
Package watch is the host-side half of `m watch` (spec §3.1, §9): a save triggered inner loop that re-runs the engine-neutral checks (lint, fmt) on changed files.
|
Package watch is the host-side half of `m watch` (spec §3.1, §9): a save triggered inner loop that re-runs the engine-neutral checks (lint, fmt) on changed files. |
|
workspace
Package workspace is an in-memory cross-routine index of M source: every routine's labels (declarations) and outbound call sites (references).
|
Package workspace is an in-memory cross-routine index of M source: every routine's labels (declarations) and outbound call sites (references). |
Click to show internal directories.
Click to hide internal directories.