majordomus quality report
Změří crate a ohlásí každé zjištění s pravidlem, které porušuje, a tím, co s tím dělat
majordomus quality report
Použití
majordomus quality report [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
|
| --code | <CODE> | — | Jen zjištění s tímto kódem, např. RUST_PUBLIC_MISSING_EXAMPLE |
| --path | <PATH> | — | Pouze zjištění pod tímto prefixem cesty relativní k repozitáři |
| --summary | flag | — | Vypsat počty a vynechat nálezy |
| --include-baselined | flag | — | Zobrazit zjištění, která baseline již přijímá a která se ve výchozím stavu vynechávají |
| --write-baseline | flag | — | Zaznamenat dnešní nálezy jako přijatou baseline, aby dluh mohl klesat a nemohl růst |
Příklady
-
Kde stojí veřejný povrch cratu
Samotné počty: kolik z exportovaného povrchu je zdokumentováno a opatřeno příkladem, kolik modulů něco cvičí a jak kanonické operace stojí proti příkazové řádce, HTTP, OpenAPI a MCP. Skončí kódem 10, když některý nález stojí mimo zaznamenanou baseline.
$ majordomus quality report --summaryCo tvrdí: skončí s kódem 0.
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í.
-
Jeden druh nálezu, s pravidlem a nápravou
Filtrováno na jeden kód porušení. Každé zjištění nese pravidlo, které ho vyžaduje, kde je, proč na něm záleží a co dělat — díky čemuž může člověk i agent jednat podle téže zprávy.
$ majordomus quality report --code RUST_MODULE_MISSING_EXAMPLE --format jsonCo tvrdí: skončí s kódem 0; vypíše jeden dokument JSON s /measured, /passes, /report/schema.
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 report --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.