-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Auto merge of #10582 - epage:pkgid, r=ehuss
Extend pkgid syntax with `@` support In addition to `foo:1.2.3`, we now support `[email protected]` for pkgids. We are also making it the default way of rendering pkgid's for the user. ### What does this PR try to resolve? With cargo-add in #10472, we've decided to only use ``@`` in it and to add it as an alternative to `:` in the rest of cargo. `cargo-add` originally used ``@`.` When preparing it for merge, I switched to `:` to be consistent with pkgids. When discussing this, it was felt ``@`` has precedence in too many tools to switch to `:` but that we should instead switch pkgid's to use ``@`,` in a backwards compatible way. #10472 served as the change proposal for this See also - https://internals.rust-lang.org/t/feedback-on-cargo-add-before-its-merged/16024/26?u=epage - https://rust-lang.zulipchat.com/#narrow/stream/246057-t-cargo/topic/Multiple.20ways.20of.20specifying.20versions ### How should we test and review this PR? The focus of the testing is on the parsers unit tests and on the end-to-end output. We are not explicitly testing end-to-end input in this PR, assuming the unit tests are sufficient. ### Additional information This only focuses on places we already accept pkgids. Looking into supporting `[email protected]` in `cargo install` and `cargo yank` is being left for a future PR.
- Loading branch information
Showing
17 changed files
with
89 additions
and
61 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -41,8 +41,10 @@ impl PackageIdSpec { | |
| /// "https://crates.io/foo", | ||
| /// "https://crates.io/foo#1.2.3", | ||
| /// "https://crates.io/foo#bar:1.2.3", | ||
| /// "https://crates.io/foo#[email protected]", | ||
| /// "foo", | ||
| /// "foo:1.2.3", | ||
| /// "[email protected]", | ||
| /// ]; | ||
| /// for spec in specs { | ||
| /// assert!(PackageIdSpec::parse(spec).is_ok()); | ||
|
|
@@ -65,7 +67,7 @@ impl PackageIdSpec { | |
| ); | ||
| } | ||
| } | ||
| let mut parts = spec.splitn(2, ':'); | ||
| let mut parts = spec.splitn(2, [':', '@']); | ||
| let name = parts.next().unwrap(); | ||
| let version = match parts.next() { | ||
| Some(version) => Some(version.to_semver()?), | ||
|
|
@@ -122,7 +124,7 @@ impl PackageIdSpec { | |
| })?; | ||
| match frag { | ||
| Some(fragment) => { | ||
| let mut parts = fragment.splitn(2, ':'); | ||
| let mut parts = fragment.splitn(2, [':', '@']); | ||
| let name_or_version = parts.next().unwrap(); | ||
| match parts.next() { | ||
| Some(part) => { | ||
|
|
@@ -268,7 +270,7 @@ impl PackageIdSpec { | |
| } | ||
| for id in ids { | ||
| if version_cnt[id.version()] == 1 { | ||
| msg.push_str(&format!("\n {}:{}", spec.name(), id.version())); | ||
| msg.push_str(&format!("\n {}@{}", spec.name(), id.version())); | ||
| } else { | ||
| msg.push_str(&format!("\n {}", PackageIdSpec::from_package_id(*id))); | ||
| } | ||
|
|
@@ -290,11 +292,11 @@ impl fmt::Display for PackageIdSpec { | |
| } | ||
| None => { | ||
| printed_name = true; | ||
| write!(f, "{}", self.name)? | ||
| write!(f, "{}", self.name)?; | ||
| } | ||
| } | ||
| if let Some(ref v) = self.version { | ||
| write!(f, "{}{}", if printed_name { ":" } else { "#" }, v)?; | ||
| write!(f, "{}{}", if printed_name { "@" } else { "#" }, v)?; | ||
| } | ||
| Ok(()) | ||
| } | ||
|
|
@@ -329,10 +331,11 @@ mod tests { | |
|
|
||
| #[test] | ||
| fn good_parsing() { | ||
| fn ok(spec: &str, expected: PackageIdSpec) { | ||
| #[track_caller] | ||
| fn ok(spec: &str, expected: PackageIdSpec, expected_rendered: &str) { | ||
| let parsed = PackageIdSpec::parse(spec).unwrap(); | ||
| assert_eq!(parsed, expected); | ||
| assert_eq!(parsed.to_string(), spec); | ||
| assert_eq!(parsed.to_string(), expected_rendered); | ||
| } | ||
|
|
||
| ok( | ||
|
|
@@ -342,6 +345,7 @@ mod tests { | |
| version: None, | ||
| url: Some(Url::parse("https://crates.io/foo").unwrap()), | ||
| }, | ||
| "https://crates.io/foo", | ||
| ); | ||
| ok( | ||
| "https://crates.io/foo#1.2.3", | ||
|
|
@@ -350,6 +354,7 @@ mod tests { | |
| version: Some("1.2.3".to_semver().unwrap()), | ||
| url: Some(Url::parse("https://crates.io/foo").unwrap()), | ||
| }, | ||
| "https://crates.io/foo#1.2.3", | ||
| ); | ||
| ok( | ||
| "https://crates.io/foo#bar:1.2.3", | ||
|
|
@@ -358,6 +363,16 @@ mod tests { | |
| version: Some("1.2.3".to_semver().unwrap()), | ||
| url: Some(Url::parse("https://crates.io/foo").unwrap()), | ||
| }, | ||
| "https://crates.io/foo#[email protected]", | ||
| ); | ||
| ok( | ||
| "https://crates.io/foo#[email protected]", | ||
| PackageIdSpec { | ||
| name: InternedString::new("bar"), | ||
| version: Some("1.2.3".to_semver().unwrap()), | ||
| url: Some(Url::parse("https://crates.io/foo").unwrap()), | ||
| }, | ||
| "https://crates.io/foo#[email protected]", | ||
| ); | ||
| ok( | ||
| "foo", | ||
|
|
@@ -366,6 +381,7 @@ mod tests { | |
| version: None, | ||
| url: None, | ||
| }, | ||
| "foo", | ||
| ); | ||
| ok( | ||
| "foo:1.2.3", | ||
|
|
@@ -374,6 +390,16 @@ mod tests { | |
| version: Some("1.2.3".to_semver().unwrap()), | ||
| url: None, | ||
| }, | ||
| "[email protected]", | ||
| ); | ||
| ok( | ||
| "[email protected]", | ||
| PackageIdSpec { | ||
| name: InternedString::new("foo"), | ||
| version: Some("1.2.3".to_semver().unwrap()), | ||
| url: None, | ||
| }, | ||
| "[email protected]", | ||
| ); | ||
| } | ||
|
|
||
|
|
@@ -382,6 +408,9 @@ mod tests { | |
| assert!(PackageIdSpec::parse("baz:").is_err()); | ||
| assert!(PackageIdSpec::parse("baz:*").is_err()); | ||
| assert!(PackageIdSpec::parse("baz:1.0").is_err()); | ||
| assert!(PackageIdSpec::parse("baz@").is_err()); | ||
| assert!(PackageIdSpec::parse("baz@*").is_err()); | ||
| assert!(PackageIdSpec::parse("[email protected]").is_err()); | ||
| assert!(PackageIdSpec::parse("https://baz:1.0").is_err()); | ||
| assert!(PackageIdSpec::parse("https://#baz:1.0").is_err()); | ||
| } | ||
|
|
@@ -397,5 +426,7 @@ mod tests { | |
| assert!(!PackageIdSpec::parse("foo").unwrap().matches(bar)); | ||
| assert!(PackageIdSpec::parse("foo:1.2.3").unwrap().matches(foo)); | ||
| assert!(!PackageIdSpec::parse("foo:1.2.2").unwrap().matches(foo)); | ||
| assert!(PackageIdSpec::parse("[email protected]").unwrap().matches(foo)); | ||
| assert!(!PackageIdSpec::parse("[email protected]").unwrap().matches(foo)); | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,12 +9,12 @@ is a string which is used to uniquely refer to one package within a graph of | |
| packages. | ||
|
|
||
| The specification may be fully qualified, such as | ||
| `https://github.com/rust-lang/crates.io-index#regex:1.4.3` or it may be | ||
| `https://github.com/rust-lang/crates.io-index#regex@1.4.3` or it may be | ||
| abbreviated, such as `regex`. The abbreviated form may be used as long as it | ||
| uniquely identifies a single package in the dependency graph. If there is | ||
| ambiguity, additional qualifiers can be added to make it unique. For example, | ||
| if there are two versions of the `regex` package in the graph, then it can be | ||
| qualified with a version to make it unique, such as `regex:1.4.3`. | ||
| qualified with a version to make it unique, such as `regex@1.4.3`. | ||
|
|
||
| #### Specification grammar | ||
|
|
||
|
|
@@ -23,7 +23,7 @@ The formal grammar for a Package Id Specification is: | |
| ```notrust | ||
| spec := pkgname | ||
| | proto "://" hostname-and-path [ "#" ( pkgname | semver ) ] | ||
| pkgname := name [ ":" semver ] | ||
| pkgname := name [ ("@" | ":" ) semver ] | ||
| proto := "http" | "git" | ... | ||
| ``` | ||
|
|
@@ -40,17 +40,17 @@ The following are references to the `regex` package on `crates.io`: | |
| | Spec | Name | Version | | ||
| |:------------------------------------------------------------|:-------:|:-------:| | ||
| | `regex` | `regex` | `*` | | ||
| | `regex:1.4.3` | `regex` | `1.4.3` | | ||
| | `regex@1.4.3` | `regex` | `1.4.3` | | ||
| | `https://github.com/rust-lang/crates.io-index#regex` | `regex` | `*` | | ||
| | `https://github.com/rust-lang/crates.io-index#regex:1.4.3` | `regex` | `1.4.3` | | ||
| | `https://github.com/rust-lang/crates.io-index#regex@1.4.3` | `regex` | `1.4.3` | | ||
|
|
||
| The following are some examples of specs for several different git dependencies: | ||
|
|
||
| | Spec | Name | Version | | ||
| |:----------------------------------------------------------|:----------------:|:--------:| | ||
| | `https://github.com/rust-lang/cargo#0.52.0` | `cargo` | `0.52.0` | | ||
| | `https://github.com/rust-lang/cargo#cargo-platform:0.1.2` | <nobr>`cargo-platform`</nobr> | `0.1.2` | | ||
| | `ssh://[email protected]/rust-lang/regex.git#regex:1.4.3` | `regex` | `1.4.3` | | ||
| | `https://github.com/rust-lang/cargo#cargo-platform@0.1.2` | <nobr>`cargo-platform`</nobr> | `0.1.2` | | ||
| | `ssh://[email protected]/rust-lang/regex.git#regex@1.4.3` | `regex` | `1.4.3` | | ||
|
|
||
| Local packages on the filesystem can use `file://` URLs to reference them: | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -361,7 +361,7 @@ fn yank() { | |
| .with_stderr( | ||
| "\ | ||
| [UPDATING] [..] | ||
| [YANK] foo:0.1.0 | ||
| [YANK] foo@0.1.0 | ||
| ", | ||
| ) | ||
| .run(); | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.