Use hyphens in long CLI flags to be consistent with GNU utils

dimo414 / bkt

a subprocess caching utility, available as a command line binary and a Rust library.

https://www.bkt.rs

MIT License

251 stars 13 forks source link

Use hyphens in long CLI flags to be consistent with GNU utils #2

Closed tranzystorekk closed 3 years ago

tranzystorekk commented 3 years ago

Highlights:

Switches word separator for flags from underscores _ to hyphens - making long flags POSIX (--use_working_dir ➡️ --use-working-dir)
Uses .visible_alias(...) so that clap documents aliases automatically

For formatting, a github action can be set up that doesn't allow merging unformatted code.

tranzystorekk commented 3 years ago

@dimo414 I'm guessing you haven't had the time to review these changes, either way I'd like to thank you for welcoming me as a contributor 😄

dimo414 commented 3 years ago

Yes sorry for the delay, it's just a large PR and I haven't made time to look through it. Will do so soon.

dimo414 commented 3 years ago

Ah, I didn't realize the bulk of this PR was just cargo fmt, and I had been delaying reviewing it until I could go through your changes in detail.

I appreciate the motivation for using a formatter, but I'd intentionally not run cargo fmt on the project so far. I might decide to set up formatting in the future but at a minimum I'd want to add enforcement and probably also tune the formatter via a rustfmt.toml as well.

The changes in 697f2092 LG though, so if you want to remove the cargo fmt commit I can merge that.

tranzystorekk commented 3 years ago

@dimo414 agreed, I just reset the formatting commit :)