majordomus generate
Zapíše commitnuté projekce registru (docs/generated), nebo zkontroluje, že jsou aktuální
majordomus generate
Použití
majordomus generate [OPTIONS] [TARGET]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) |
| <TARGET> | all | openapi | docs | benchmarks | registry | allow | providers | editors | site | manifest | distribution | web | changelog | deployment | graph | design | economics | vše | Co generovat
|
| --check | flag | — | Porovnat s tím, co je na disku, a při zastaralosti skončit kódem 10; nic nezapisovat |
| --out | <DIR> | — | Zapisovat pod tento adresář místo kořene repozitáře (připojí se docs/generated) |
Příklady
-
Zapsat každou commitovanou projekci
Dokument OpenAPI, reference schopností, reference příkazové řádky a její JSON, manifest registru, matice měření výkonu, seznamy povolených shellového nástroje, bootstrapy poskytovatelů a datová sada registru webu — vše z jednoho registru a jedné deklarace clap.
$ majordomus generateCo 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í.
-
Odmítnout strom se zastaralými projekcemi
Nic nezapisuje a místo toho porovnává: exit 0, když je každá commitnutá projekce tím, co vytvářejí zdroje, exit 10 s pojmenováním každého zastaralého souboru. Toto je forma, kterou spouští CI.
$ majordomus generate $ majordomus generate --checkCo 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í.
-
Jen jeden cíl
Každý cíl lze zapsat samostatně, zatímco se změna ladí; `majordomus generate` bez cíle zapíše všechny.
$ majordomus generate openapiCo 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í.
-
Zkontrolovat jeden cíl bez jeho zápisu
`--check` se skládá s cílem: zde se s tím, co produkují zdroje, porovnává jen datová sada registru, kterou web vykresluje, a když je zastaralá, skončí kódem 10 s jejím pojmenováním.
$ majordomus generate site $ majordomus generate site --checkCo 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í.
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 generate --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.