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

Open Beginner friendly
#60 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
78/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Active
Tech stack
dart
Domain
cli

Research direction

Start in lib/core/cli/simcrux_cli.dart at SimcruxCli.run: the HelpCliArgs branch prints CliArgParser().usage, and the "nothing to do" path prints the same block, so both need the new text. Add a top-level usage constant (Usage: simcrux <command> [options], each subcommand with a one-line description, then the option table) and print it from both paths. Add a test asserting the help text names every subcommand run dispatches on, so done means that test passes and subcommand help still exits 0.

Written by the indexing model from the issue text.

Description

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.

Dominant language
Dart
Stars
0
Forks
0
Avg merge
2d 10h
Merged PRs (30d)
3

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Ferrite-Engineering/simcrux

All issues in Ferrite-Engineering/simcrux

Similar issues

More Dart issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.