Split crates and clean up structure of codebase (#294)

Co-authored-by: Jiahao XU <Jiahao_XU@outlook.com>

crates/bin/src/args.rs

@@ -0,0 +1,252 @@
+use std::{ffi::OsString, path::PathBuf};
+
+use binstall::{
+    errors::BinstallError,
+    manifests::cargo_toml_binstall::PkgFmt,
+    ops::resolve::{CrateName, VersionReqExt},
+};
+use clap::{builder::PossibleValue, AppSettings, ArgEnum, Parser};
+use log::LevelFilter;
+use reqwest::tls::Version;
+use semver::VersionReq;
+
+#[derive(Debug, Parser)]
+#[clap(version, about = "Install a Rust binary... from binaries!", setting = AppSettings::ArgRequiredElseHelp)]
+pub struct Args {
+    /// Packages to install.
+    ///
+    /// Syntax: crate[@version]
+    ///
+    /// Each value is either a crate name alone, or a crate name followed by @ and the version to
+    /// install. The version syntax is as with the --version option.
+    ///
+    /// When multiple names are provided, the --version option and any override options are
+    /// unavailable due to ambiguity.
+    ///
+    /// If duplicate names are provided, the last one (and their version requirement)
+    /// is kept.
+    #[clap(
+    help_heading = "Package selection",
+    value_name = "crate[@version]",
+    required_unless_present_any = ["version", "help"],
+)]
+    pub crate_names: Vec<CrateName>,
+
+    /// Package version to install.
+    ///
+    /// Takes either an exact semver version or a semver version requirement expression, which will
+    /// be resolved to the highest matching version available.
+    ///
+    /// Cannot be used when multiple packages are installed at once, use the attached version
+    /// syntax in that case.
+    #[clap(help_heading = "Package selection", long = "version", parse(try_from_str = VersionReq::parse_from_cli))]
+    pub version_req: Option<VersionReq>,
+
+    /// Override binary target set.
+    ///
+    /// Binstall is able to look for binaries for several targets, installing the first one it finds
+    /// in the order the targets were given. For example, on a 64-bit glibc Linux distribution, the
+    /// default is to look first for a `x86_64-unknown-linux-gnu` binary, then for a
+    /// `x86_64-unknown-linux-musl` binary. However, on a musl system, the gnu version will not be
+    /// considered.
+    ///
+    /// This option takes a comma-separated list of target triples, which will be tried in order.
+    /// They override the default list, which is detected automatically from the current platform.
+    ///
+    /// If falling back to installing from source, the first target will be used.
+    #[clap(
+        help_heading = "Package selection",
+        alias = "target",
+        long,
+        value_name = "TRIPLE"
+    )]
+    pub targets: Option<String>,
+
+    /// Override Cargo.toml package manifest path.
+    ///
+    /// This skips searching crates.io for a manifest and uses the specified path directly, useful
+    /// for debugging and when adding Binstall support. This may be either the path to the folder
+    /// containing a Cargo.toml file, or the Cargo.toml file itself.
+    #[clap(help_heading = "Overrides", long)]
+    pub manifest_path: Option<PathBuf>,
+
+    /// Override Cargo.toml package manifest bin-dir.
+    #[clap(help_heading = "Overrides", long)]
+    pub bin_dir: Option<String>,
+
+    /// Override Cargo.toml package manifest pkg-fmt.
+    #[clap(help_heading = "Overrides", long)]
+    pub pkg_fmt: Option<PkgFmt>,
+
+    /// Override Cargo.toml package manifest pkg-url.
+    #[clap(help_heading = "Overrides", long)]
+    pub pkg_url: Option<String>,
+
+    /// Disable symlinking / versioned updates.
+    ///
+    /// By default, Binstall will install a binary named `<name>-<version>` in the install path, and
+    /// either symlink or copy it to (depending on platform) the plain binary name. This makes it
+    /// possible to have multiple versions of the same binary, for example for testing or rollback.
+    ///
+    /// Pass this flag to disable this behavior.
+    #[clap(help_heading = "Options", long)]
+    pub no_symlinks: bool,
+
+    /// Dry run, fetch and show changes without installing binaries.
+    #[clap(help_heading = "Options", long)]
+    pub dry_run: bool,
+
+    /// Disable interactive mode / confirmation prompts.
+    #[clap(help_heading = "Options", long)]
+    pub no_confirm: bool,
+
+    /// Do not cleanup temporary files.
+    #[clap(help_heading = "Options", long)]
+    pub no_cleanup: bool,
+
+    /// Install binaries in a custom location.
+    ///
+    /// By default, binaries are installed to the global location `$CARGO_HOME/bin`, and global
+    /// 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
+    /// global metadata files are not updated.
+    #[clap(help_heading = "Options", long)]
+    pub install_path: Option<PathBuf>,
+
+    /// Enforce downloads over secure transports only.
+    ///
+    /// Insecure HTTP downloads will be removed completely in the future; in the meantime this
+    /// option forces a fail when the remote endpoint uses plaintext HTTP or insecure TLS suites.
+    ///
+    /// Without this option, plain HTTP will warn.
+    ///
+    /// Implies `--min-tls-version=1.2`.
+    #[clap(help_heading = "Options", long)]
+    pub secure: bool,
+
+    /// Force a crate to be installed even if it is already installed.
+    #[clap(help_heading = "Options", long)]
+    pub force: bool,
+
+    /// Require a minimum TLS version from remote endpoints.
+    ///
+    /// The default is not to require any minimum TLS version, and use the negotiated highest
+    /// version available to both this client and the remote server.
+    #[clap(help_heading = "Options", long, arg_enum, value_name = "VERSION")]
+    pub min_tls_version: Option<TLSVersion>,
+
+    /// Print help information
+    #[clap(help_heading = "Meta", short, long)]
+    pub help: bool,
+
+    /// Print version information
+    #[clap(help_heading = "Meta", short = 'V')]
+    pub version: bool,
+
+    /// Utility log level
+    ///
+    /// Set to `trace` to print very low priority, often extremely
+    /// verbose information.
+    ///
+    /// Set to `debug` when submitting a bug report.
+    ///
+    /// Set to `info` to only print useful information.
+    ///
+    /// Set to `warn` to only print on hazardous situations.
+    ///
+    /// Set to `error` to only print serious errors.
+    ///
+    /// Set to `off` to disable logging completely, this will also
+    /// disable output from `cargo-install`.
+    #[clap(
+        help_heading = "Meta",
+        long,
+        default_value = "info",
+        value_name = "LEVEL",
+        possible_values = [
+            PossibleValue::new("trace").help(
+                "Set to `trace` to print very low priority, often extremely verbose information."
+            ),
+            PossibleValue::new("debug").help("Set to debug when submitting a bug report."),
+            PossibleValue::new("info").help("Set to info to only print useful information."),
+            PossibleValue::new("warn").help("Set to warn to only print on hazardous situations."),
+            PossibleValue::new("error").help("Set to error to only print serious errors."),
+            PossibleValue::new("off").help(
+                "Set to off to disable logging completely, this will also disable output from `cargo-install`."
+            ),
+        ]
+    )]
+    pub log_level: LevelFilter,
+
+    /// Equivalent to setting `log_level` to `off`.
+    ///
+    /// This would override the `log_level`.
+    #[clap(help_heading = "Meta", short, long)]
+    pub quiet: bool,
+}
+
+#[derive(Debug, Copy, Clone, ArgEnum)]
+pub enum TLSVersion {
+    #[clap(name = "1.2")]
+    Tls1_2,
+    #[clap(name = "1.3")]
+    Tls1_3,
+}
+
+impl From<TLSVersion> for Version {
+    fn from(ver: TLSVersion) -> Self {
+        match ver {
+            TLSVersion::Tls1_2 => Version::TLS_1_2,
+            TLSVersion::Tls1_3 => Version::TLS_1_3,
+        }
+    }
+}
+
+pub fn parse() -> Result<Args, BinstallError> {
+    // Filter extraneous arg when invoked by cargo
+    // `cargo run -- --help` gives ["target/debug/cargo-binstall", "--help"]
+    // `cargo binstall --help` gives ["/home/ryan/.cargo/bin/cargo-binstall", "binstall", "--help"]
+    let mut args: Vec<OsString> = std::env::args_os().collect();
+    let args = if args.len() > 1 && args[1] == "binstall" {
+        // Equivalent to
+        //
+        //     args.remove(1);
+        //
+        // But is O(1)
+        args.swap(0, 1);
+        let mut args = args.into_iter();
+        drop(args.next().unwrap());
+
+        args
+    } else {
+        args.into_iter()
+    };
+
+    // Load options
+    let mut opts = Args::parse_from(args);
+    if opts.quiet {
+        opts.log_level = LevelFilter::Off;
+    }
+
+    if opts.crate_names.len() > 1 {
+        let option = if opts.version_req.is_some() {
+            "version"
+        } else if opts.manifest_path.is_some() {
+            "manifest-path"
+        } else if opts.bin_dir.is_some() {
+            "bin-dir"
+        } else if opts.pkg_fmt.is_some() {
+            "pkg-fmt"
+        } else if opts.pkg_url.is_some() {
+            "pkg-url"
+        } else {
+            ""
+        };
+
+        if !option.is_empty() {
+            return Err(BinstallError::OverrideOptionUsedWithMultiInstall { option }.into());
+        }
+    }
+
+    Ok(opts)
+}