Skip to content

majordomus web report ui

The UI conformance audit, rendered as a section of the test surface (/tests/ui)

majordomus web report ui

Usage

majordomus web report ui [OPTIONS]

Arguments

argumentvaluedefaultdescription
--from <FROM> required A results document from `scripts/ui audit`
--repo <PATH> Start the search for the repository root here (default: the current directory) (accepted by every subcommand)
--discovery vcs | filesystem vcs How declarative files are enumerated (accepted by every subcommand)
  • vcs — Tracked files, through the version-control index (the layer's contract)
  • filesystem — A walk of the work tree with the same glob semantics; untracked files included
--strict flag Refuse to proceed when any file of the layer carries an error diagnostic (accepted by every subcommand)
--share <DIR> The tool distribution's share directory (kinds.yaml, schemas/); default: $MAJORDOMUS_SHARE, then the repository's own share/, then the one beside the executable (accepted by every subcommand)
--format text | json text Output shape (accepted by every subcommand)
  • text — Lines for a person
  • json — One JSON document, deterministic
--only <ONLY> Only these surfaces, by discovered id (repeat or separate with commas) (accepted by every subcommand)
--exclude <EXCLUDE> Every surface except these, by discovered id (accepted by every subcommand)

Examples

  • Render the UI conformance audit into /tests/ui

    `scripts/ui audit` drives a browser over every page of the built site at every width the compiled stylesheet's breakpoints imply, and writes one results document; this renders it. The rendering is a section of the test surface rather than a surface of its own, because a conformance run is a test run and the topology refuses a surface mounted inside another's subtree. Without that document there is nothing to render and the command says so.

    $ majordomus web report ui --from target/web/run-ui.json

    Verified by the example tests: exits 13.

Where this comes from

Declared once in apps/majordomus-cli/src/cli.rs: clap for the structure, typed Rust metadata beside it for the examples. This page, majordomus web report ui --help, docs/generated/cli.md and docs/generated/cli.json are projections of that one declaration.

The whole command line on one page: the registry's command-line page. The task lifecycle (init, start, finish, doctor, ...) belongs to the shell tool, a different program: Commands and its specification.