Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Group flags in --help #13

Open
smhmd opened this issue Aug 21, 2020 · 1 comment · Fixed by #16
Open

Group flags in --help #13

smhmd opened this issue Aug 21, 2020 · 1 comment · Fixed by #16

Comments

@smhmd
Copy link
Contributor

smhmd commented Aug 21, 2020

I'm not sure if this is possible within your CLI framework, but grouping flags as such (or some other way):

CONVENTIONS:
    -k, --kebab        Uses the kebab-case naming convention
    -p, --pascal       Uses the PascalCase naming convention
        --screaming    Uses the SCREAMING_SNAKE_CASE naming convention
    -S, --sentence     Uses the Sentence case naming convention
    -T, --title        Uses the Title Case naming convention
    -t, --train        Uses the Train-Case naming convention
    -c, --camel        Uses the camelCase naming convention
    -s, --snake        Uses the snake_case naming convention

FLAGS:
    -D, --dir          Renames directories as well
    -r, --recursive    Makes renaming recursive, renaming files in subfolders as well
    -q, --quiet        Suppress output

    -h, --help         Prints help information
    -V, --version      Prints version information

And, perhaps, to simplify USAGE as such:

USAGE:
    stdrename [FLAGS] <convention> [TARGET]
@Gadiguibou
Copy link
Owner

The second part is done. For the first one, I'd have to open an issue on the clap crate (the current argument parser) or keep the whole help message updated manually. I'm not sure if I want that yet. Keeping this open for now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants