actions/cargo-binstall
1
0
Fork 0
mirror of https://github.com/cargo-bins/cargo-binstall.git synced 2025-06-15 15:16:37 +00:00
Code Issues Projects Releases Packages Wiki Activity

fix: shorten value placeholders in help text

Browse source
This commit is contained in:
Josh McKinney 2025-02-14 17:20:45 -08:00
parent bcff00b2ee
commit 74d2fae013
No known key found for this signature in database
GPG key ID: 722287396A903BC5
1 changed files with 28 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

37
crates/bin/src/args.rs
View file

@ -67,7 +67,8 @@ pub struct Args {
#[clap( #[clap(
help_heading = "Package selection", help_heading = "Package selection",
long = "version", long = "version",
value_parser(VersionReq::parse_from_cli) value_parser(VersionReq::parse_from_cli),
value_name = "VERSION"
)] )]
pub(crate) version_req: Option<VersionReq>, pub(crate) version_req: Option<VersionReq>,
@ -98,7 +99,7 @@ pub struct Args {
/// containing a Cargo.toml file, or the Cargo.toml file itself. /// containing a Cargo.toml file, or the Cargo.toml file itself.
/// ///
/// This option cannot be used with `--git`. /// This option cannot be used with `--git`.
#[clap(help_heading = "Overrides", long)] #[clap(help_heading = "Overrides", long, value_name = "PATH")]
pub(crate) manifest_path: Option<PathBuf>, pub(crate) manifest_path: Option<PathBuf>,
#[cfg(feature = "git")] #[cfg(feature = "git")]
@ -108,7 +109,12 @@ pub struct Args {
/// runs as if `--manifest-path $cloned_repo` is passed to binstall. /// runs as if `--manifest-path $cloned_repo` is passed to binstall.
/// ///
/// This option cannot be used with `--manifest-path`. /// This option cannot be used with `--manifest-path`.
#[clap(help_heading = "Overrides", long, conflicts_with("manifest_path"))] #[clap(
help_heading = "Overrides",
long,
conflicts_with("manifest_path"),
value_name = "URL"
)]
pub(crate) git: Option<binstalk::registry::GitUrl>, pub(crate) git: Option<binstalk::registry::GitUrl>,
/// Override Cargo.toml package manifest bin-dir. /// Override Cargo.toml package manifest bin-dir.
@ -136,7 +142,7 @@ pub struct Args {
pub(crate) pkg_fmt: Option<PkgFmt>, pub(crate) pkg_fmt: Option<PkgFmt>,
/// Override Cargo.toml package manifest pkg-url. /// Override Cargo.toml package manifest pkg-url.
#[clap(help_heading = "Overrides", long)] #[clap(help_heading = "Overrides", long, value_name = "URL")]
pub(crate) pkg_url: Option<String>, pub(crate) pkg_url: Option<String>,
/// Override the rate limit duration. /// Override the rate limit duration.
@ -155,7 +161,8 @@ pub struct Args {
help_heading = "Overrides", help_heading = "Overrides",
long, long,
default_value_t = RateLimit::default(), default_value_t = RateLimit::default(),
env = "BINSTALL_RATE_LIMIT" env = "BINSTALL_RATE_LIMIT",
value_name = "LIMIT",
)] )]
pub(crate) rate_limit: RateLimit, pub(crate) rate_limit: RateLimit,
@ -186,7 +193,8 @@ pub struct Args {
help_heading = "Overrides", help_heading = "Overrides",
long, long,
value_delimiter(','), value_delimiter(','),
env = "BINSTALL_DISABLE_STRATEGIES" env = "BINSTALL_DISABLE_STRATEGIES",
value_name = "STRATEGIES"
)] )]
pub(crate) disable_strategies: Vec<StrategyWrapped>, pub(crate) disable_strategies: Vec<StrategyWrapped>,
@ -208,6 +216,7 @@ pub struct Args {
long, long,
env = "BINSTALL_MAXIMUM_RESOLUTION_TIMEOUT", env = "BINSTALL_MAXIMUM_RESOLUTION_TIMEOUT",
default_value_t = NonZeroU16::new(15).unwrap(), default_value_t = NonZeroU16::new(15).unwrap(),
value_name = "TIMEOUT"
)] )]
pub(crate) maximum_resolution_timeout: NonZeroU16, pub(crate) maximum_resolution_timeout: NonZeroU16,
@ -267,7 +276,7 @@ pub struct Args {
/// metadata files are updated with the package information. Specifying another path here /// metadata files are updated with the package information. Specifying another path here
/// switches over to a "local" install, where binaries are installed at the path given, and the /// switches over to a "local" install, where binaries are installed at the path given, and the
/// global metadata files are not updated. /// global metadata files are not updated.
#[clap(help_heading = "Options", long)] #[clap(help_heading = "Options", long, value_name = "PATH")]
pub(crate) install_path: Option<PathBuf>, pub(crate) install_path: Option<PathBuf>,
/// Install binaries with a custom cargo root. /// Install binaries with a custom cargo root.
@ -333,7 +342,12 @@ pub struct Args {
/// Specify the root certificates to use for https connnections, /// Specify the root certificates to use for https connnections,
/// in addition to default system-wide ones. /// in addition to default system-wide ones.
#[clap(help_heading = "Options", long, env = "BINSTALL_HTTPS_ROOT_CERTS")] #[clap(
help_heading = "Options",
long,
env = "BINSTALL_HTTPS_ROOT_CERTS",
value_name = "PATH"
)]
pub(crate) root_certificates: Vec<PathBuf>, pub(crate) root_certificates: Vec<PathBuf>,
/// Print logs in json format to be parsable. /// Print logs in json format to be parsable.
@ -349,7 +363,12 @@ pub struct Args {
/// If none of them is present, then binstall will try to extract github /// If none of them is present, then binstall will try to extract github
/// token from `$HOME/.git-credentials` or `$HOME/.config/gh/hosts.yml` /// token from `$HOME/.git-credentials` or `$HOME/.config/gh/hosts.yml`
/// unless `--no-discover-github-token` is specified. /// unless `--no-discover-github-token` is specified.
#[clap(help_heading = "Options", long, env = "GITHUB_TOKEN")] #[clap(
help_heading = "Options",
long,
env = "GITHUB_TOKEN",
value_name = "TOKEN"
)]
pub(crate) github_token: Option<GithubToken>, pub(crate) github_token: Option<GithubToken>,
/// Only install packages that are signed /// Only install packages that are signed