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

[BUG]: Subcommands in the --help stdout don't look like the options stdout #64

Closed
orowith2os opened this issue Sep 18, 2022 · 7 comments
Labels
bug Something isn't working

Comments

@orowith2os
Copy link

Describe the bug

The subcommands seem to have a bit of a typo, they're missing a comma to separate the pacman-style commands from plain english.

To reproduce the bug

Run ame --help

Expected behavior

The subcommands --help area would look similar to the options area.

Screenshots

No response

Additional context

❯ ame --help
Amethyst 4.0.0 (Funky Fish)
A fast and efficient AUR helper

USAGE:
    ame [OPTIONS] [SUBCOMMAND]

OPTIONS:
    -c, --cachedir <CACHEDIR>    Sets a custom AUR clone and build directory for the specified operation
    -h, --help                   Print help information
        --noconfirm              Complete operation without prompting user
    -q, --quiet                  Make some commands have less output
        --sudoloop               Loops sudo in the background to ensure it doesn't time out during long builds
    -v, --verbose                Sets the level of verbosity
    -V, --version                Print version information

SUBCOMMANDS:
    clean -C      Removes all orphaned packages
    diff -d       Runs pacdiff
    gencomp -G    Generates shell completions for supported shells (bash, fish, elvish, pwsh)
    help          Print this message or the help of the given subcommand(s)
    query -Q      Queries installed packages
    remove -R     Removes a previously installed package [aliases: rm]
    search        Searches for packages matching a provided pattern in the AUR/repos [aliases: -Ss]
    sync -S       Installs or searches for a package in either the AUR or the Pacman-defined repositories
                      [aliases: install, i]
    upgrade       Upgrades locally installed packages to their latest versions (Default) [aliases: -Syu]

This should instead be:

❯ ame --help
Amethyst 4.0.0 (Funky Fish)
A fast and efficient AUR helper

USAGE:
    ame [OPTIONS] [SUBCOMMAND]

OPTIONS:
    -c, --cachedir <CACHEDIR>    Sets a custom AUR clone and build directory for the specified operation
    -h, --help                   Print help information
        --noconfirm              Complete operation without prompting user
    -q, --quiet                  Make some commands have less output
        --sudoloop               Loops sudo in the background to ensure it doesn't time out during long builds
    -v, --verbose                Sets the level of verbosity
    -V, --version                Print version information

SUBCOMMANDS:
    clean, -C      Removes all orphaned packages
    diff, -d       Runs pacdiff
    gencomp, -G    Generates shell completions for supported shells (bash, fish, elvish, pwsh)
    help          Print this message or the help of the given subcommand(s)
    query, -Q      Queries installed packages
    remove, -R     Removes a previously installed package [aliases: rm]
    search        Searches for packages matching a provided pattern in the AUR/repos [aliases: -Ss]
    sync, -S       Installs or searches for a package in either the AUR or the Pacman-defined repositories
                      [aliases: install, i]
    upgrade       Upgrades locally installed packages to their latest versions (Default) [aliases: -Syu]
@orowith2os orowith2os added the bug Something isn't working label Sep 18, 2022
@fries1234
Copy link
Contributor

looks like this is a clap thing i dont think we can do much about this 😔

@orowith2os
Copy link
Author

Should be fixed soon, for now just gonna tough it out.

@fries1234
Copy link
Contributor

uh can we use git HEAD for main and wait for 4.0.0 release or would that be a bad idea

@orowith2os
Copy link
Author

Why not backport the fix and use our own crate for it, then use upstream again when v4 is released? Less risk of breakage due to an unstable lib.

@fries1234
Copy link
Contributor

i guess we could do that

@Trivernis
Copy link
Member

Trivernis commented Sep 19, 2022

As this is just a minor visual bug I wouldn't go the lengths of maintaining a fork of clap until it's fixed or rather until clap v4 is released

@orowith2os
Copy link
Author

I'll close this issue then, see yall on the update lol

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants