Refactor CLI, group flags, add aliases and support for env variables

[fischeti]

CLI refactor

derive feature

Since a while clap supports declaritive structs instead of a runtime builder, which is now the recommended way to build CLIs. It is easier to read, and modify and the resulting implementation is very clean in my opinion. Especially when it comes to subcommands which are represented as enums in Rust.

CLI organisation

I reorganized all the CLI subcommands and flags, in a way that should still be backwards compatible:

• Script targets i.e. bender script <target> are now implemented as nested subcommands of script. This change is mainly reflected when calling the help page of script.
• Some of the script targets where previously defined as global but were not used by all targets and had to be checked inside script.rs. Examples are --vlog-arg, --vcom-arg and --only-*. Now, they are moved/duplicated into each target that uses them which automatically takes care of these checks.
• The --only-* flags are grouped, meaning clap will automatically return an error if multiple one of them are specified at the same time. The same goes for packages --graph, that does not allow --version and/or --targets
• Some flags have been renamed i.e. --vlog-arg was used by all targets for general verilog arguments even though the underlying executable has a different name. Now, the flag is called --vlogan-arg for VCS, but backward compatibility is ensured with aliases to --vlog-arg.
• The help pages are now colored and the flags are now grouped into global options and subcommand specific options (+ subsubcommand options for bender script <target> --help).
• Several aliases were introduced, which do not show up on help pages but are compatible. Those mainly consist of the plural/singular version of the flag e.g. --vlog-args/--vlog-arg both work now or parents/parent as well.

Environment variables

Global flags (e.g. git throttle, local, dir etc., ) can now also be provided as environment variables. The help pages also reflect this. The precedence is flag > environment variable > default.

TODOs:

• Fix plugins (or deprecate them?)
• Remove comments after review (of previous CLI command builders)
• Evaluate further optimizations (e.g. bender script <target> could be implemented as subsubcommands with enums instead of strings if possible)
• Remove redundant $[arg(long = <field-but-dashed>, short = <first-letter-of-field>]
• Potentially deprecate modify previous --vcom-args etc., in favor of tool-specific args (with graceful deprecation warning in the beginning) with aliases to keep backward compability
• Consider using env feature of clap to set flags based on environment variables (and deprecate config?)
• Fix Windows tests (or not?). Currently there is an inconsistency with new line delimiters. Fixed in CLI regression tests #245
• Decide how/whether to merge cli_regression test suite moved to CLI regression tests #245
• Change flag and add backward compatible aliases for flags that used lower_case i.e. vendor had some.
• Address all inline TODOs
• Review of consisteny between old CLI and new one ensure backward compability
• Wait for CLI regression tests #245 to be merged

[micprog]

Thanks for the additions! I really like the new format and what it enables in code cleanliness, as well as the predefined environment variables for certain flags. I haven't gone through the script.rs file yet, but here is some initial feedback.

[micprog]

The script command looks OK at first glance, I think testing through usage will reveal any issues here. The CLI regression tests failures also look as expected.

[fischeti]

Thanks for the review and catching some errors that I missed! I should have addressed all of your comments. There are currently three CLI tests failing which is expected:

    cli_synopsys_verilog_arg
    cli_synopsys_vhdl_arg
    cli_verilator_args

Those are "new" argument names that didn't exist before (but with backward compatible aliases that are also checked with in the *_old_* tests).

The one that I don't really know what to do about is the cli_template_json. It is kind of expected that it fails, because it does not contain some arguments anymore that were previously global to script.

[micprog]

LGTM, thanks!