cargo 0.100.0

Cargo, a package manager for Rust.
Documentation
//! Crate name parsing.

use anyhow::Context as _;

use super::Dependency;
use crate::CargoResult;
use crate::workspace::editor::dependency::RegistrySource;
use cargo_util_schemas::manifest::PackageName;

/// User-specified crate
///
/// This can be a
/// - Name (e.g. `docopt`)
/// - Name and a version req (e.g. `docopt@^0.8`)
#[derive(Debug)]
pub struct CrateSpec {
    /// Crate name
    name: String,
    /// Optional version requirement
    version_req: Option<String>,
}

impl CrateSpec {
    /// Convert a string to a `Crate`
    pub fn resolve(pkg_id: &str) -> CargoResult<Self> {
        let (name, version) = pkg_id
            .split_once('@')
            .map(|(n, v)| (n, Some(v)))
            .unwrap_or((pkg_id, None));

        let package_name = PackageName::new(name);
        if !pkg_id.contains("@") && package_name.is_err() {
            for (idx, ch) in pkg_id.char_indices() {
                if !(unicode_ident::is_xid_continue(ch) || ch == '-') {
                    let mut suggested_pkg_id = pkg_id.to_string();
                    suggested_pkg_id.insert_str(idx, "@");
                    if let Ok(_) = CrateSpec::resolve(&suggested_pkg_id.as_str()) {
                        let err = package_name.unwrap_err();
                        return Err(
                            anyhow::format_err!("{err}\n\n\
                                help: if this is meant to be a package name followed by a version, insert an `@` like `{suggested_pkg_id}`").into());
                    }
                }
            }
        }

        package_name?;

        if let Some(version) = version {
            semver::VersionReq::parse(version).with_context(|| {
                if let Some(stripped) = version.strip_prefix("v") {
                    return format!(
                        "the version provided, `{version}` is not a \
                         valid SemVer requirement\n\n\
                         help: changing the package to `{name}@{stripped}`",
                    );
                }
                format!("invalid version requirement `{version}`")
            })?;
        }

        let id = Self {
            name: name.to_owned(),
            version_req: version.map(|s| s.to_owned()),
        };

        Ok(id)
    }

    /// Generate a dependency entry for this crate specifier
    pub fn to_dependency(&self) -> CargoResult<Dependency> {
        let mut dep = Dependency::new(self.name());
        if let Some(version_req) = self.version_req() {
            dep = dep.set_source(RegistrySource::new(version_req));
        }
        Ok(dep)
    }

    pub fn name(&self) -> &str {
        &self.name
    }

    pub fn version_req(&self) -> Option<&str> {
        self.version_req.as_deref()
    }
}