fix(shell): Switch to annotate snippets for notes

Author: epage

src/cargo/core/shell.rs

@@ -227,7 +227,10 @@ impl Shell {
 
     /// Prints a cyan 'note' message.
     pub fn note<T: fmt::Display>(&mut self, message: T) -> CargoResult<()> {
-        self.print(&"note", Some(&message), &NOTE, false)
+        let report = &[annotate_snippets::Group::with_title(
+            annotate_snippets::Level::NOTE.secondary_title(message.to_string()),
+        )];
+        self.print_report(report, false)
     }
 
     /// Updates the verbosity of the shell.

tests/testsuite/alt_registry.rs

@@ -363,7 +363,7 @@ See https://doc.rust-lang.org/cargo/reference/manifest.html#package-metadata for
 [UPLOADING] foo v0.0.1 ([ROOT]/foo)
 [UPLOADED] foo v0.0.1 to registry `alternative`
 [NOTE] waiting for foo v0.0.1 to be available at registry `alternative`.
-You may press ctrl-c to skip waiting; the crate should be available shortly.
+      You may press ctrl-c to skip waiting; the crate should be available shortly.
 [PUBLISHED] foo v0.0.1 at registry `alternative`
 
 "#]])
@@ -526,7 +526,7 @@ See https://doc.rust-lang.org/cargo/reference/manifest.html#package-metadata for
 [UPLOADING] foo v0.0.1 ([ROOT]/foo)
 [UPLOADED] foo v0.0.1 to registry `alternative`
 [NOTE] waiting for foo v0.0.1 to be available at registry `alternative`.
-You may press ctrl-c to skip waiting; the crate should be available shortly.
+      You may press ctrl-c to skip waiting; the crate should be available shortly.
 [PUBLISHED] foo v0.0.1 at registry `alternative`
 
 "#]])
@@ -608,7 +608,7 @@ See https://doc.rust-lang.org/cargo/reference/manifest.html#package-metadata for
 [UPLOADING] foo v0.0.1 ([ROOT]/foo)
 [UPLOADED] foo v0.0.1 to registry `alternative`
 [NOTE] waiting for foo v0.0.1 to be available at registry `alternative`.
-You may press ctrl-c to skip waiting; the crate should be available shortly.
+      You may press ctrl-c to skip waiting; the crate should be available shortly.
 [PUBLISHED] foo v0.0.1 at registry `alternative`
 
 "#]])

tests/testsuite/artifact_dep.rs

@@ -2262,7 +2262,7 @@ fn publish_artifact_dep() {
 [UPLOADING] foo v0.1.0 ([ROOT]/foo)
 [UPLOADED] foo v0.1.0 to registry `crates-io`
 [NOTE] waiting for foo v0.1.0 to be available at registry `crates-io`.
-You may press ctrl-c to skip waiting; the crate should be available shortly.
+      You may press ctrl-c to skip waiting; the crate should be available shortly.
 [PUBLISHED] foo v0.1.0 at registry `crates-io`
 
 "#]])

tests/testsuite/cargo_features.rs

@@ -708,7 +708,7 @@ See https://doc.rust-lang.org/cargo/reference/manifest.html#package-metadata for
 [UPLOADING] a v0.0.1 ([ROOT]/foo)
 [UPLOADED] a v0.0.1 to registry `crates-io`
 [NOTE] waiting for a v0.0.1 to be available at registry `crates-io`.
-You may press ctrl-c to skip waiting; the crate should be available shortly.
+      You may press ctrl-c to skip waiting; the crate should be available shortly.
 [PUBLISHED] a v0.0.1 at registry `crates-io`
 
 "#]])

tests/testsuite/credential_process.rs

@@ -81,7 +81,7 @@ fn publish() {
 {"v":1,"registry":{"index-url":"[..]","name":"alternative"},"kind":"get","operation":"publish","name":"foo","vers":"0.1.0","cksum":"[..]"}
 [UPLOADED] foo v0.1.0 to registry `alternative`
 [NOTE] waiting for foo v0.1.0 to be available at registry `alternative`.
-You may press ctrl-c [..]
+      You may press ctrl-c to skip waiting; the crate should be available shortly.
 [PUBLISHED] foo v0.1.0 at registry `alternative`
 
 "#]])
@@ -564,7 +564,7 @@ fn token_caching() {
 {"v":1,"registry":{"index-url":"[..]","name":"alternative"},"kind":"get","operation":"publish","name":"foo","vers":"0.1.0","cksum":"[..]"}
 [UPLOADED] foo v0.1.0 to registry `alternative`
 [NOTE] waiting [..]
-You may press ctrl-c [..]
+      You may press ctrl-c to skip waiting; the crate should be available shortly.
 [PUBLISHED] foo v0.1.0 at registry `alternative`
 
 "#]];
@@ -585,7 +585,7 @@ You may press ctrl-c [..]
 {"v":1,"registry":{"index-url":"[..]","name":"alternative"},"kind":"get","operation":"publish","name":"foo","vers":"0.1.1","cksum":"[..]"}
 [UPLOADED] foo v0.1.1 to registry `alternative`
 [NOTE] waiting [..]
-You may press ctrl-c [..]
+      You may press ctrl-c to skip waiting; the crate should be available shortly.
 [PUBLISHED] foo v0.1.1 at registry `alternative`
 
 "#]];

tests/testsuite/features_namespaced.rs

@@ -931,7 +931,7 @@ fn publish_no_implicit() {
 [UPLOADING] foo v0.1.0 ([ROOT]/foo)
 [UPLOADED] foo v0.1.0 to registry `crates-io`
 [NOTE] waiting for foo v0.1.0 to be available at registry `crates-io`.
-You may press ctrl-c to skip waiting; the crate should be available shortly.
+      You may press ctrl-c to skip waiting; the crate should be available shortly.
 [PUBLISHED] foo v0.1.0 at registry `crates-io`
 
 "#]])
@@ -1075,7 +1075,7 @@ fn publish() {
 [UPLOADING] foo v0.1.0 ([ROOT]/foo)
 [UPLOADED] foo v0.1.0 to registry `crates-io`
 [NOTE] waiting for foo v0.1.0 to be available at registry `crates-io`.
-You may press ctrl-c to skip waiting; the crate should be available shortly.
+      You may press ctrl-c to skip waiting; the crate should be available shortly.
 [PUBLISHED] foo v0.1.0 at registry `crates-io`
 
 "#]])

tests/testsuite/future_incompat_report.rs

@@ -147,22 +147,22 @@ fn incompat_in_dependency() {
 [FINISHED] `dev` profile [unoptimized + debuginfo] target(s) in [ELAPSED]s
 [WARNING] the following packages contain code that will be rejected by a future version of Rust: bar v1.0.0
 [NOTE] 
-To solve this problem, you can try the following approaches:
-
-- If the issue is not solved by updating the dependencies, a fix has to be
-implemented by those dependencies. You can help with that by notifying the
-maintainers of this problem (e.g. by creating a bug report) or by proposing a
-fix to the maintainers (e.g. by creating a pull request):
-
-  - [email protected]
-  - Repository: https://example.com/
-  - Detailed warning command: `cargo report future-incompatibilities --id 1 --package [email protected]`
-
-- If waiting for an upstream fix is not an option, you can use the `[patch]`
-section in `Cargo.toml` to use your own version of the dependency. For more
-information, see:
-https://doc.rust-lang.org/cargo/reference/overriding-dependencies.html#the-patch-section
-
+      To solve this problem, you can try the following approaches:
+      
+      - If the issue is not solved by updating the dependencies, a fix has to be
+      implemented by those dependencies. You can help with that by notifying the
+      maintainers of this problem (e.g. by creating a bug report) or by proposing a
+      fix to the maintainers (e.g. by creating a pull request):
+      
+        - [email protected]
+        - Repository: https://example.com/
+        - Detailed warning command: `cargo report future-incompatibilities --id 1 --package [email protected]`
+      
+      - If waiting for an upstream fix is not an option, you can use the `[patch]`
+      section in `Cargo.toml` to use your own version of the dependency. For more
+      information, see:
+      https://doc.rust-lang.org/cargo/reference/overriding-dependencies.html#the-patch-section
+      
 [NOTE] this report can be shown with `cargo report future-incompatibilities --id 1`
 
 "#]])
@@ -372,9 +372,9 @@ fn test_multi_crate() {
 ...
 [WARNING] the following packages contain code that will be rejected by a future version of Rust: first-dep v0.0.1, second-dep v0.0.2
 ...
-  - [email protected]
+        - [email protected]
 ...
-  - [email protected]
+        - [email protected]
 ...
 ")
             .run();
@@ -601,38 +601,38 @@ fn suggestions_for_updates() {
 [FINISHED] `dev` profile [unoptimized + debuginfo] target(s) in [ELAPSED]s
 [WARNING] the following packages contain code that will be rejected by a future version of Rust: big_update v1.0.0, with_updates v1.0.0, without_updates v1.0.0
 [NOTE] 
-To solve this problem, you can try the following approaches:
-
-
-- Some affected dependencies have newer versions available.
-You may want to consider updating them to a newer version to see if the issue has been fixed.
-
-big_update v1.0.0 has the following newer versions available: 2.0.0
-with_updates v1.0.0 has the following newer versions available: 1.0.1, 1.0.2, 3.0.1
-
-
-- If the issue is not solved by updating the dependencies, a fix has to be
-implemented by those dependencies. You can help with that by notifying the
-maintainers of this problem (e.g. by creating a bug report) or by proposing a
-fix to the maintainers (e.g. by creating a pull request):
-
-  - [email protected]
-  - Repository: <not found>
-  - Detailed warning command: `cargo report future-incompatibilities --id 1 --package [email protected]`
-
-  - [email protected]
-  - Repository: <not found>
-  - Detailed warning command: `cargo report future-incompatibilities --id 1 --package [email protected]`
-
-  - [email protected]
-  - Repository: <not found>
-  - Detailed warning command: `cargo report future-incompatibilities --id 1 --package [email protected]`
-
-- If waiting for an upstream fix is not an option, you can use the `[patch]`
-section in `Cargo.toml` to use your own version of the dependency. For more
-information, see:
-https://doc.rust-lang.org/cargo/reference/overriding-dependencies.html#the-patch-section
 [NOTE] this report can be shown with `cargo report future-incompatibilities --id 1`
+      To solve this problem, you can try the following approaches:
+      
+      
+      - Some affected dependencies have newer versions available.
+      You may want to consider updating them to a newer version to see if the issue has been fixed.
+      
+      big_update v1.0.0 has the following newer versions available: 2.0.0
+      with_updates v1.0.0 has the following newer versions available: 1.0.1, 1.0.2, 3.0.1
+      
+      - If the issue is not solved by updating the dependencies, a fix has to be
+      implemented by those dependencies. You can help with that by notifying the
+      maintainers of this problem (e.g. by creating a bug report) or by proposing a
+      fix to the maintainers (e.g. by creating a pull request):
+      
+        - [email protected]
+        - Repository: <not found>
+        - Detailed warning command: `cargo report future-incompatibilities --id 1 --package [email protected]`
+      
+        - [email protected]
+        - Repository: <not found>
+        - Detailed warning command: `cargo report future-incompatibilities --id 1 --package [email protected]`
+      
+        - [email protected]
+        - Repository: <not found>
+        - Detailed warning command: `cargo report future-incompatibilities --id 1 --package [email protected]`
+      
+      - If waiting for an upstream fix is not an option, you can use the `[patch]`
+      section in `Cargo.toml` to use your own version of the dependency. For more
+      information, see:
+      https://doc.rust-lang.org/cargo/reference/overriding-dependencies.html#the-patch-section
+      
 
 "#]].unordered())
         .run();
@@ -718,22 +718,22 @@ fn correct_report_id_when_cached() {
 [FINISHED] `dev` profile [unoptimized + debuginfo] target(s) in [ELAPSED]s
 [WARNING] the following packages contain code that will be rejected by a future version of Rust: bar v1.0.0
 [NOTE] 
-To solve this problem, you can try the following approaches:
-
-- If the issue is not solved by updating the dependencies, a fix has to be
-implemented by those dependencies. You can help with that by notifying the
-maintainers of this problem (e.g. by creating a bug report) or by proposing a
-fix to the maintainers (e.g. by creating a pull request):
-
-  - [email protected]
-  - Repository: https://example.com/
-  - Detailed warning command: `cargo report future-incompatibilities --id 1 --package [email protected]`
-
-- If waiting for an upstream fix is not an option, you can use the `[patch]`
-section in `Cargo.toml` to use your own version of the dependency. For more
-information, see:
-https://doc.rust-lang.org/cargo/reference/overriding-dependencies.html#the-patch-section
-
+      To solve this problem, you can try the following approaches:
+      
+      - If the issue is not solved by updating the dependencies, a fix has to be
+      implemented by those dependencies. You can help with that by notifying the
+      maintainers of this problem (e.g. by creating a bug report) or by proposing a
+      fix to the maintainers (e.g. by creating a pull request):
+      
+        - [email protected]
+        - Repository: https://example.com/
+        - Detailed warning command: `cargo report future-incompatibilities --id 1 --package [email protected]`
+      
+      - If waiting for an upstream fix is not an option, you can use the `[patch]`
+      section in `Cargo.toml` to use your own version of the dependency. For more
+      information, see:
+      https://doc.rust-lang.org/cargo/reference/overriding-dependencies.html#the-patch-section
+      
 [NOTE] this report can be shown with `cargo report future-incompatibilities --id 1`
 
 "#]])
@@ -745,22 +745,22 @@ https://doc.rust-lang.org/cargo/reference/overriding-dependencies.html#the-patch
 [FINISHED] `dev` profile [unoptimized + debuginfo] target(s) in [ELAPSED]s
 [WARNING] the following packages contain code that will be rejected by a future version of Rust: bar v1.0.0
 [NOTE] 
-To solve this problem, you can try the following approaches:
-
-- If the issue is not solved by updating the dependencies, a fix has to be
-implemented by those dependencies. You can help with that by notifying the
-maintainers of this problem (e.g. by creating a bug report) or by proposing a
-fix to the maintainers (e.g. by creating a pull request):
-
-  - [email protected]
-  - Repository: https://example.com/
-  - Detailed warning command: `cargo report future-incompatibilities --id 1 --package [email protected]`
-
-- If waiting for an upstream fix is not an option, you can use the `[patch]`
-section in `Cargo.toml` to use your own version of the dependency. For more
-information, see:
-https://doc.rust-lang.org/cargo/reference/overriding-dependencies.html#the-patch-section
-
+      To solve this problem, you can try the following approaches:
+      
+      - If the issue is not solved by updating the dependencies, a fix has to be
+      implemented by those dependencies. You can help with that by notifying the
+      maintainers of this problem (e.g. by creating a bug report) or by proposing a
+      fix to the maintainers (e.g. by creating a pull request):
+      
+        - [email protected]
+        - Repository: https://example.com/
+        - Detailed warning command: `cargo report future-incompatibilities --id 1 --package [email protected]`
+      
+      - If waiting for an upstream fix is not an option, you can use the `[patch]`
+      section in `Cargo.toml` to use your own version of the dependency. For more
+      information, see:
+      https://doc.rust-lang.org/cargo/reference/overriding-dependencies.html#the-patch-section
+      
 [NOTE] this report can be shown with `cargo report future-incompatibilities --id 1`
 
 "#]])

tests/testsuite/inheritable_workspace_fields.rs

@@ -168,7 +168,7 @@ fn inherit_own_workspace_fields() {
 [UPLOADING] foo v1.2.3 ([ROOT]/foo)
 [UPLOADED] foo v1.2.3 to registry `crates-io`
 [NOTE] waiting for foo v1.2.3 to be available at registry `crates-io`.
-You may press ctrl-c to skip waiting; the crate should be available shortly.
+      You may press ctrl-c to skip waiting; the crate should be available shortly.
 [PUBLISHED] foo v1.2.3 at registry `crates-io`
 
 "#]])
@@ -335,7 +335,7 @@ See https://doc.rust-lang.org/cargo/reference/manifest.html#package-metadata for
 [UPLOADING] bar v0.2.0 ([ROOT]/foo)
 [UPLOADED] bar v0.2.0 to registry `crates-io`
 [NOTE] waiting for bar v0.2.0 to be available at registry `crates-io`.
-You may press ctrl-c to skip waiting; the crate should be available shortly.
+      You may press ctrl-c to skip waiting; the crate should be available shortly.
 [PUBLISHED] bar v0.2.0 at registry `crates-io`
 
 "#]])
@@ -502,7 +502,7 @@ See https://doc.rust-lang.org/cargo/reference/manifest.html#package-metadata for
 [UPLOADING] bar v0.2.0 ([ROOT]/foo)
 [UPLOADED] bar v0.2.0 to registry `crates-io`
 [NOTE] waiting for bar v0.2.0 to be available at registry `crates-io`.
-You may press ctrl-c to skip waiting; the crate should be available shortly.
+      You may press ctrl-c to skip waiting; the crate should be available shortly.
 [PUBLISHED] bar v0.2.0 at registry `crates-io`
 
 "#]])
@@ -763,7 +763,7 @@ See https://doc.rust-lang.org/cargo/reference/manifest.html#the-license-and-lice
 [UPLOADING] bar v1.2.3 ([ROOT]/foo/bar)
 [UPLOADED] bar v1.2.3 to registry `crates-io`
 [NOTE] waiting for bar v1.2.3 to be available at registry `crates-io`.
-You may press ctrl-c to skip waiting; the crate should be available shortly.
+      You may press ctrl-c to skip waiting; the crate should be available shortly.
 [PUBLISHED] bar v1.2.3 at registry `crates-io`
 
 "#]])
@@ -937,7 +937,7 @@ See https://doc.rust-lang.org/cargo/reference/manifest.html#package-metadata for
 [UPLOADING] bar v0.2.0 ([ROOT]/foo/bar)
 [UPLOADED] bar v0.2.0 to registry `crates-io`
 [NOTE] waiting for bar v0.2.0 to be available at registry `crates-io`.
-You may press ctrl-c to skip waiting; the crate should be available shortly.
+      You may press ctrl-c to skip waiting; the crate should be available shortly.
 [PUBLISHED] bar v0.2.0 at registry `crates-io`
 
 "#]])