majordomus quality rustdoc
Posoudit strom rustdoc crate vůči crate: každá stránka je přítomná, odpovídá HEADu, nic není rozbité ani uniklé
majordomus quality rustdoc
Použití
majordomus quality rustdoc [OPTIONS]Argumenty
| argument | hodnota | výchozí | popis |
|---|---|---|---|
| --repo | <PATH> | — | Zde začne hledání kořene repozitáře (výchozí: aktuální adresář) (přijímá každý podpříkaz) |
| --discovery | vcs | filesystem | vcs | Jak se vyhledávají deklarativní soubory (přijímá každý podpříkaz)
|
| --strict | flag | — | Odmítne pokračovat, pokud kterýkoli soubor vrstvy nese diagnostiku typu chyba (přijímá každý podpříkaz) |
| --share | <DIR> | — | Adresář share distribuce nástroje (kinds.yaml, schemas/); výchozí: $MAJORDOMUS_SHARE, poté vlastní share/ repozitáře, poté ten vedle spustitelného souboru (přijímá každý podpříkaz) |
| --format | text | json | text | Tvar výstupu
|
| --kind | <KIND> | — | Pouze nálezy tohoto druhu, např. missing-page, orphan-page, stale, link, machine-path |
| --summary | flag | — | Vypsat verdikt a počty a nálezy vynechat |
| --tree | <DIR> | — | Posoudit tento adresář místo artefaktu povrchu rustdoc, např. site/public/rustdoc |
Příklady
-
Zda je strom rustdoc crate úplný, aktuální a zdravý
Strom povrchu rustdoc posuzovaný vůči vlastnímu inventáři cratu: stránka každé exportované položky na své cestě, žádná stránka bez položky, sestaveno z HEAD, index a jeho assety přítomné, každý relativní odkaz vyřešen, nic, co by jmenovalo stroj nebo mělo tvar přihlašovacího údaje. Končí kódem 0 při čistém stavu, 10 se zjištěními a 12, když není co posuzovat — jako zde, v repozitáři, který nenese žádný crate v Rustu, nebo všude tam, kde producent (scripts/rust-check --doc) neběžel. Kontrola, která svůj předmět nevidí, to řekne; nikdy nehlásí čisto.
$ majordomus quality rustdocCo tvrdí: exit 12.
Testuje apps/majordomus-cli/tests/cli_examples.rs, který spouští příkaz nad sestaveným programem a ověřuje, co stránka uvádí.
-
Další kopie stromu, posuzovaná stejně
Adresář zadaný na příkazové řádce — strom, který scripts/site-build složil do webu — posouzený stejným posouzením, jako dokument, kterým odpovídá každý transport: verdikt, počty, každý exportovaný modul s jeho stránkou a jeden typovaný nález za každou vadu. Adresář zadává jen člověk u vlastního terminálu; přes HTTP a MCP je předmětem vždy artefakt povrchu.
$ majordomus quality rustdoc --tree site/public/rustdoc --format jsonCo tvrdí: exit 12.
Testuje apps/majordomus-cli/tests/cli_examples.rs, který spouští příkaz nad sestaveným programem a ověřuje, co stránka uvádí.
Odkud to pochází
Deklarováno jednou v apps/majordomus-cli/src/cli.rs: clap pro strukturu, typovaná metadata v Rustu vedle něj pro příklady. Tato stránka, majordomus quality rustdoc --help, docs/generated/cli.md a docs/generated/cli.json jsou projekce této jediné deklarace.
Celá příkazová řádka na jedné stránce: stránka příkazové řádky registru. Životní cyklus úlohy (init, start, finish, doctor, ...) patří nástroji shell, jinému programu: Příkazy a jeho specifikace.