majordomus commit validate
Posoudit jednu zprávu commitu podle politiky commitů repozitáře; kód 10, pokud je nález chyba
majordomus commit validate
Použití
majordomus commit validate [OPTIONS] [FILE]Argumenty
| argument | hodnota | výchozí | popis |
|---|---|---|---|
| <FILE> | <FILE> | — | Soubor se zprávou; bez zadání se čte standardní vstup, což má hook `commit-msg` |
| --paths | <PATHS> | — | Posoudit jako commit těchto cest, oddělených čárkou: to, co je potřebuje — například zda oprava nese test — se jinak neposuzuje, ne hádá |
| --rev | <REV> | — | Posoudit zprávu tohoto commitu místo souboru: jakákoli revize, kterou `git show` přijímá |
| --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 (přijímá každý podpříkaz)
|
Příklady
-
Verdikt o commitu, který už vznikl
`--rev` posuzuje zprávu libovolné revize, kterou `git show` přijímá; bez něj se zpráva čte ze souboru nebo ze standardního vstupu, což je tvar, který má hook `commit-msg`. Kód ukončení je verdikt: 0, když se nenašlo nic s vážností chyby, 10, když ano. Zde je první commit repozitáře se subjektem `install`, který není ve tvaru `type(scope): subject`, takže odpověď je 10 a nález pojmenovává jedenáct slov typů.
$ majordomus commit validate --rev HEADCo tvrdí: exit 10.
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 commit validate --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.