From 2b28d1c8fc37025cfb29e5e6b899932a37200561 Mon Sep 17 00:00:00 2001 From: Kinflou Date: Sun, 8 Nov 2026 13:11:53 +0800 Subject: [PATCH] reference: comline conformance --json --- docs/docs/reference/tools/cli.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/reference/tools/cli.md b/docs/docs/reference/tools/cli.md index a1ec9a3..439e593 100644 --- a/docs/docs/reference/tools/cli.md +++ b/docs/docs/reference/tools/cli.md @@ -41,7 +41,7 @@ parse → resolve imports → validate → (freeze into .comline/) → (generate | `comline release [1.0] [--raise --reason ] [--yes]` | Build, then release: create the version from the highest bump since the last release ([builds and releases](../versioning.md#builds-and-releases)). `--raise patch\|minor\|major` goes higher, with a `--reason` recorded with the release; it never lowers. `1.0` makes a `0.x` package stable after showing what that commits to (its protocols, and what's worth settling first). Raising to major and `1.0` ask on a terminal; without one they refuse (exit `2`) unless `--yes` (`-y`). | | `comline diff []` | Show schema changes between two built versions. Each argument is a version (`0.2.0`), a commit hash (4+ chars), or `HEAD` (`` default). | | `comline doc [--out ] [--version ] [--changelog-from ] [--format ] [--open]` | Write the package's documentation for every version (each release, dev build and the unreleased working state), each into `///` with the changelog from the version before it: Markdown pages (an index, one page per module with its `//!` header, every declaration's `///` docs and each protocol's wire summary, a changelog, an mkdocs/zensical `nav.yml`), `--format html` for a self-contained static site with the same content, a search box, a version picker and a page comparing versions, or `--format json` for the documentation model. Built versions are cached, so a run re-renders only the unreleased state and new versions; `--version` documents one built version. Defaults from [`comline.toml`](../congregation/comline-toml.md#doc)'s `[doc]`. `comline doc open []` (or `--open` after a render) opens the result with the system's default handler, rendering first if it isn't there. No `.comline/` write. See [comline doc](cli/doc.md). | -| `comline conformance --impl [--encoding ]... [--corpus ] [--timeout ]` | Run an implementation of an encoding against its vectors. The package's declared [`encodings`](../../developer/extending/encodings.md) ship vectors beside their profiles (`profiles/x.vectors.json`); `--impl` is a process speaking the [ops protocol](../conformance.md#the-ops-protocol), run once with a cleared environment, a time limit (`--timeout`, 60 s) and a capped stdout. `--encoding` limits the run to one encoding (repeatable); `--corpus` runs a corpus laid out like the runtime's `runtime/conformance` instead, which is how the official encodings are proven. A failed or unimplemented case, or an unproven profile fact, exits `1`. See [Formats and framings](../../developer/extending/encodings.md#3-write-vectors-and-prove-an-implementation). | +| `comline conformance --impl [--encoding ]... [--corpus ] [--timeout ] [--json]` | Run an implementation of an encoding against its vectors. The package's declared [`encodings`](../../developer/extending/encodings.md) ship vectors beside their profiles (`profiles/x.vectors.json`); `--impl` is a process speaking the [ops protocol](../conformance.md#the-ops-protocol), run once with a cleared environment, a time limit (`--timeout`, 60 s) and a capped stdout. `--encoding` limits the run to one encoding (repeatable); `--corpus` runs a corpus laid out like the runtime's `runtime/conformance` instead, which is how the official encodings are proven. A failed or unimplemented case, or an unproven profile fact, exits `1`. `--json` prints the report as JSON on stdout instead (nothing else on stdout; the exit code is the same): `format` (`1`), `implementation` (`command` and the `version` it reported, with its `protocol`), `encodings` (each with `name`, `kind`, `listed_by_implementation`, `passed`, `total`, `facts` as `{fact, value, proven, reason}` and `cases` as `{id, outcome, detail}` where `outcome` is `pass`, `fail` or `not_implemented`), `totals` (`encodings`, `cases`, `passed`, `problems`) and `verdict` (`conforms` or `fails`). See [Formats and framings](../../developer/extending/encodings.md#3-write-vectors-and-prove-an-implementation). | | `comline clean [--dry-run]` | Remove generated code (the `generate` output root or files). Never touches `.comline/`. | | `comline reset [--force] [--dry-run]` | **Destructive.** Delete `.comline/` — the whole version history, no undo — *and* generated code. Next `build` starts over at `0.1.0-dev.1`. On a terminal it shows how many versions will be lost and makes you type `reset`; without a terminal it refuses (exit `2`) unless `--force`. | | `comline completions ` | Print a completion script to stdout. `bash` `zsh` `fish` `powershell` `elvish`. |