simcrux --help prints only the option table: no usage line, no subcommand list

Aperta Adatta ai principianti
#60 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
78/100
Tipo di issue
Funzionalità
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
dart
Ambito
cli

Direzione di ricerca

Inizia in lib/core/cli/simcrux_cli.dart su SimcruxCli.run: il ramo HelpCliArgs stampa CliArgParser().usage, e il percorso «nothing to do» stampa lo stesso blocco, quindi entrambi necessitano del nuovo testo. Aggiungi una costante di usage di livello superiore (Usage: simcrux <command> [options], ogni sottocomando con una descrizione di una riga, poi la tabella delle opzioni) e stampala da entrambi i percorsi. Aggiungi un test che verifichi che il testo di aiuto nomini ogni sottocomando su cui run fa dispatch, quindi fatto significa che quel test passa e che l'aiuto del sottocomando esce ancora con 0.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Found while smoke-testing the 1.2.0 builds on Windows and Linux.

simcrux --help prints only the option table. There is no Usage: line and no list of the subcommands (import-sby, import-eqy, import-riscv-arch-test, import-riscv-formal, export-dashboard, license, flow). The subcommands only appear in the "nothing to do headless" error, so someone reading --help cannot discover them. The Pro CLI's --help prints a Usage: simcrux-pro <command> [options] line, every command, and each command's own text.

Where: lib/core/cli/simcrux_cli.dart, SimcruxCli.run. The HelpCliArgs branch prints CliArgParser().usage, which is the ArgParser option table and nothing else. The "nothing to do" path prints the same block.

Likely fix: a top-level usage constant with a Usage: simcrux <command> [options] line, the subcommand list with a one-line description each, then the option table. Print it for --help and for the no-work error. A test should assert the help text mentions every subcommand that run dispatches on, so a new subcommand cannot be added without being listed.

Subcommand help (simcrux import-sby -h, simcrux flow --help) already works and exits 0.

Found in 1.2.0.

Lingua principale
Dart
Stelle
0
Fork
0
Merge medio
2g 10h
PR unite (30g)
3

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di Ferrite-Engineering/simcrux

Tutte le issue di Ferrite-Engineering/simcrux

Issue simili

Altre issue su Dart

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.