fix(shell): Switch to annotate snippets for warn/note

Author: epage

src/cargo/core/shell.rs

@@ -222,12 +222,18 @@ impl Shell {
 
     /// Prints an amber 'warning' message.
     pub fn warn<T: fmt::Display>(&mut self, message: T) -> CargoResult<()> {
-        self.print(&"warning", Some(&message), &WARN, false)
+        let report = &[annotate_snippets::Group::with_title(
+            annotate_snippets::Level::WARNING.secondary_title(message.to_string()),
+        )];
+        self.print_report(report, false)
     }
 
     /// 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

@@ -350,7 +350,7 @@ fn publish_with_registry_dependency() {
         .with_stderr_data(str![[r#"
 [UPDATING] `alternative` index
 [WARNING] manifest has no description, license, license-file, documentation, homepage or repository.
-See https://doc.rust-lang.org/cargo/reference/manifest.html#package-metadata for more info.
+         See https://doc.rust-lang.org/cargo/reference/manifest.html#package-metadata for more info.
 [PACKAGING] foo v0.0.1 ([ROOT]/foo)
 [UPDATING] `alternative` index
 [PACKAGED] 4 files, [FILE_SIZE]B ([FILE_SIZE]B compressed)
@@ -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`
 
 "#]])
@@ -517,7 +517,7 @@ fn publish_to_alt_registry() {
         .with_stderr_data(str![[r#"
 [UPDATING] `alternative` index
 [WARNING] manifest has no description, license, license-file, documentation, homepage or repository.
-See https://doc.rust-lang.org/cargo/reference/manifest.html#package-metadata for more info.
+         See https://doc.rust-lang.org/cargo/reference/manifest.html#package-metadata for more info.
 [PACKAGING] foo v0.0.1 ([ROOT]/foo)
 [PACKAGED] 4 files, [FILE_SIZE]B ([FILE_SIZE]B compressed)
 [VERIFYING] foo v0.0.1 ([ROOT]/foo)
@@ -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`
 
 "#]])
@@ -595,7 +595,7 @@ fn publish_with_crates_io_dep() {
         .with_stderr_data(str![[r#"
 [UPDATING] `alternative` index
 [WARNING] manifest has no documentation, homepage or repository.
-See https://doc.rust-lang.org/cargo/reference/manifest.html#package-metadata for more info.
+         See https://doc.rust-lang.org/cargo/reference/manifest.html#package-metadata for more info.
 [PACKAGING] foo v0.0.1 ([ROOT]/foo)
 [UPDATING] `dummy-registry` index
 [PACKAGED] 4 files, [FILE_SIZE]B ([FILE_SIZE]B compressed)
@@ -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/bad_config.rs

@@ -842,7 +842,7 @@ fn dev_dependencies2() {
         .build();
     p.cargo("check").with_stderr_data(str![[r#"
 [WARNING] `dev_dependencies` is deprecated in favor of `dev-dependencies` and will not work in the 2024 edition
-(in the `foo` package)
+         (in the `foo` package)
 [LOCKING] 1 package to latest compatible version
 [CHECKING] foo v0.1.0 ([ROOT]/foo)
 [FINISHED] `dev` profile [unoptimized + debuginfo] target(s) in [ELAPSED]s
@@ -957,7 +957,7 @@ fn build_dependencies2() {
         .build();
     p.cargo("check").with_stderr_data(str![[r#"
 [WARNING] `build_dependencies` is deprecated in favor of `build-dependencies` and will not work in the 2024 edition
-(in the `foo` package)
+         (in the `foo` package)
 [LOCKING] 1 package to latest compatible version
 [CHECKING] foo v0.1.0 ([ROOT]/foo)
 [FINISHED] `dev` profile [unoptimized + debuginfo] target(s) in [ELAPSED]s
@@ -1065,7 +1065,7 @@ fn lib_crate_type2() {
     p.cargo("check")
         .with_stderr_data(str![[r#"
 [WARNING] `crate_type` is deprecated in favor of `crate-type` and will not work in the 2024 edition
-(in the `foo` library target)
+         (in the `foo` library target)
 [CHECKING] foo v0.5.0 ([ROOT]/foo)
 [FINISHED] `dev` profile [unoptimized + debuginfo] target(s) in [ELAPSED]s
 
@@ -1156,7 +1156,7 @@ fn bin_crate_type2() {
     p.cargo("check")
         .with_stderr_data(str![[r#"
 [WARNING] `crate_type` is deprecated in favor of `crate-type` and will not work in the 2024 edition
-(in the `foo` binary target)
+         (in the `foo` binary target)
 [CHECKING] foo v0.5.0 ([ROOT]/foo)
 [FINISHED] `dev` profile [unoptimized + debuginfo] target(s) in [ELAPSED]s
 
@@ -1265,9 +1265,9 @@ fn examples_crate_type2() {
     p.cargo("check")
         .with_stderr_data(str![[r#"
 [WARNING] `crate_type` is deprecated in favor of `crate-type` and will not work in the 2024 edition
-(in the `ex` example target)
+         (in the `ex` example target)
 [WARNING] `crate_type` is deprecated in favor of `crate-type` and will not work in the 2024 edition
-(in the `goodbye` example target)
+         (in the `goodbye` example target)
 [CHECKING] foo v0.5.0 ([ROOT]/foo)
 [FINISHED] `dev` profile [unoptimized + debuginfo] target(s) in [ELAPSED]s
 
@@ -1404,7 +1404,7 @@ fn cargo_platform_build_dependencies2() {
     p.cargo("check")
         .with_stderr_data(str![[r#"
 [WARNING] `build_dependencies` is deprecated in favor of `build-dependencies` and will not work in the 2024 edition
-(in the `[HOST_TARGET]` platform target)
+         (in the `[HOST_TARGET]` platform target)
 [LOCKING] 1 package to latest compatible version
 [COMPILING] build v0.5.0 ([ROOT]/foo/build)
 [COMPILING] foo v0.5.0 ([ROOT]/foo)
@@ -1535,7 +1535,7 @@ fn cargo_platform_dev_dependencies2() {
     p.cargo("check")
         .with_stderr_data(str![[r#"
 [WARNING] `dev_dependencies` is deprecated in favor of `dev-dependencies` and will not work in the 2024 edition
-(in the `[HOST_TARGET]` platform target)
+         (in the `[HOST_TARGET]` platform target)
 [LOCKING] 1 package to latest compatible version
 [CHECKING] foo v0.5.0 ([ROOT]/foo)
 [FINISHED] `dev` profile [unoptimized + debuginfo] target(s) in [ELAPSED]s
@@ -1664,7 +1664,7 @@ fn default_features2() {
 
     p.cargo("check").with_stderr_data(str![[r#"
 [WARNING] `default_features` is deprecated in favor of `default-features` and will not work in the 2024 edition
-(in the `a` dependency)
+         (in the `a` dependency)
 [LOCKING] 1 package to latest compatible version
 [CHECKING] a v0.1.0 ([ROOT]/foo/a)
 [CHECKING] foo v0.1.0 ([ROOT]/foo)
@@ -1833,13 +1833,13 @@ fn workspace_default_features2() {
     p.cargo("check")
         .with_stderr_data(
             str![[r#"
-(in the `dep_workspace_only` dependency)
 [CHECKING] dep_package_only v0.1.0 ([ROOT]/foo/dep_package_only)
 [CHECKING] dep_workspace_only v0.1.0 ([ROOT]/foo/dep_workspace_only)
 [CHECKING] package_only v0.1.0 ([ROOT]/foo/package_only)
 [CHECKING] workspace_only v0.1.0 ([ROOT]/foo/workspace_only)
 [FINISHED] `dev` profile [unoptimized + debuginfo] target(s) in [ELAPSED]s
 [WARNING] [ROOT]/foo/workspace_only/Cargo.toml: `default_features` is deprecated in favor of `default-features` and will not work in the 2024 edition
+         (in the `dep_workspace_only` dependency)
 
 "#]]
             .unordered(),
@@ -1950,7 +1950,7 @@ fn lib_proc_macro2() {
     foo.cargo("check")
         .with_stderr_data(str![[r#"
 [WARNING] `proc_macro` is deprecated in favor of `proc-macro` and will not work in the 2024 edition
-(in the `foo` library target)
+         (in the `foo` library target)
 [CHECKING] foo v0.1.0 ([ROOT]/foo)
 [FINISHED] `dev` profile [unoptimized + debuginfo] target(s) in [ELAPSED]s
 
@@ -2038,7 +2038,7 @@ fn bin_proc_macro2() {
     foo.cargo("check")
         .with_stderr_data(str![[r#"
 [WARNING] `proc_macro` is deprecated in favor of `proc-macro` and will not work in the 2024 edition
-(in the `foo` binary target)
+         (in the `foo` binary target)
 [CHECKING] foo v0.5.0 ([ROOT]/foo)
 [FINISHED] `dev` profile [unoptimized + debuginfo] target(s) in [ELAPSED]s
 
@@ -3476,22 +3476,22 @@ fn legacy_binary_paths_warnings() {
     p.cargo("check -v")
         .with_stderr_data(str![[r#"
 [WARNING] An explicit [[bin]] section is specified in Cargo.toml which currently
-disables Cargo from automatically inferring other binary targets.
-This inference behavior will change in the Rust 2018 edition and the following
-files will be included as a binary target:
-
-* src/main.rs
-
-This is likely to break cargo build or cargo test as these files may not be
-ready to be compiled as a binary target today. You can future-proof yourself
-and disable this warning by adding `autobins = false` to your [package]
-section. You may also move the files to a location where Cargo would not
-automatically infer them to be a target, such as in subfolders.
-
-For more information on this warning you can consult
-https://github.com/rust-lang/cargo/issues/5330
+         disables Cargo from automatically inferring other binary targets.
+         This inference behavior will change in the Rust 2018 edition and the following
+         files will be included as a binary target:
+         
+         * src/main.rs
+         
+         This is likely to break cargo build or cargo test as these files may not be
+         ready to be compiled as a binary target today. You can future-proof yourself
+         and disable this warning by adding `autobins = false` to your [package]
+         section. You may also move the files to a location where Cargo would not
+         automatically infer them to be a target, such as in subfolders.
+         
+         For more information on this warning you can consult
+         https://github.com/rust-lang/cargo/issues/5330
 [WARNING] path `src/main.rs` was erroneously implicitly accepted for binary `bar`,
-please set bin.path in Cargo.toml
+         please set bin.path in Cargo.toml
 [CHECKING] foo v1.0.0 ([ROOT]/foo)
 [RUNNING] `rustc [..]`
 [RUNNING] `rustc [..]`
@@ -3521,22 +3521,22 @@ please set bin.path in Cargo.toml
     p.cargo("check -v")
         .with_stderr_data(str![[r#"
 [WARNING] An explicit [[bin]] section is specified in Cargo.toml which currently
-disables Cargo from automatically inferring other binary targets.
-This inference behavior will change in the Rust 2018 edition and the following
-files will be included as a binary target:
-
-* src/bin/main.rs
-
-This is likely to break cargo build or cargo test as these files may not be
-ready to be compiled as a binary target today. You can future-proof yourself
-and disable this warning by adding `autobins = false` to your [package]
-section. You may also move the files to a location where Cargo would not
-automatically infer them to be a target, such as in subfolders.
-
-For more information on this warning you can consult
-https://github.com/rust-lang/cargo/issues/5330
+         disables Cargo from automatically inferring other binary targets.
+         This inference behavior will change in the Rust 2018 edition and the following
+         files will be included as a binary target:
+         
+         * src/bin/main.rs
+         
+         This is likely to break cargo build or cargo test as these files may not be
+         ready to be compiled as a binary target today. You can future-proof yourself
+         and disable this warning by adding `autobins = false` to your [package]
+         section. You may also move the files to a location where Cargo would not
+         automatically infer them to be a target, such as in subfolders.
+         
+         For more information on this warning you can consult
+         https://github.com/rust-lang/cargo/issues/5330
 [WARNING] path `src/bin/main.rs` was erroneously implicitly accepted for binary `bar`,
-please set bin.path in Cargo.toml
+         please set bin.path in Cargo.toml
 [CHECKING] foo v1.0.0 ([ROOT]/foo)
 [RUNNING] `rustc [..]`
 [RUNNING] `rustc [..]`
@@ -3565,7 +3565,7 @@ please set bin.path in Cargo.toml
     p.cargo("check -v")
         .with_stderr_data(str![[r#"
 [WARNING] path `src/bar.rs` was erroneously implicitly accepted for binary `bar`,
-please set bin.path in Cargo.toml
+         please set bin.path in Cargo.toml
 [CHECKING] foo v1.0.0 ([ROOT]/foo)
 [RUNNING] `rustc [..]`
 [FINISHED] `dev` profile [unoptimized + debuginfo] target(s) in [ELAPSED]s

tests/testsuite/bench.rs

@@ -716,20 +716,20 @@ fn bench_autodiscover_2015() {
     p.cargo("bench bench_basic")
         .with_stderr_data(str![[r#"
 [WARNING] An explicit [[bench]] section is specified in Cargo.toml which currently
-disables Cargo from automatically inferring other benchmark targets.
-This inference behavior will change in the Rust 2018 edition and the following
-files will be included as a benchmark target:
-
-* [..]bench_basic.rs
-
-This is likely to break cargo build or cargo test as these files may not be
-ready to be compiled as a benchmark target today. You can future-proof yourself
-and disable this warning by adding `autobenches = false` to your [package]
-section. You may also move the files to a location where Cargo would not
-automatically infer them to be a target, such as in subfolders.
-
-For more information on this warning you can consult
-https://github.com/rust-lang/cargo/issues/5330
+         disables Cargo from automatically inferring other benchmark targets.
+         This inference behavior will change in the Rust 2018 edition and the following
+         files will be included as a benchmark target:
+         
+         * [..]bench_basic.rs
+         
+         This is likely to break cargo build or cargo test as these files may not be
+         ready to be compiled as a benchmark target today. You can future-proof yourself
+         and disable this warning by adding `autobenches = false` to your [package]
+         section. You may also move the files to a location where Cargo would not
+         automatically infer them to be a target, such as in subfolders.
+         
+         For more information on this warning you can consult
+         https://github.com/rust-lang/cargo/issues/5330
 [COMPILING] foo v0.0.1 ([ROOT]/foo)
 [FINISHED] `bench` profile [optimized] target(s) in [ELAPSED]s
 [RUNNING] [..] (target/release/deps/foo-[HASH][EXE])
@@ -1944,7 +1944,7 @@ fn legacy_bench_name() {
     p.cargo("bench")
         .with_stderr_data(str![[r#"
 [WARNING] path `src/bench.rs` was erroneously implicitly accepted for benchmark `bench`,
-please set bench.path in Cargo.toml
+         please set bench.path in Cargo.toml
 [COMPILING] foo v0.1.0 ([ROOT]/foo)
 [FINISHED] `bench` profile [optimized] target(s) in [ELAPSED]s
 [RUNNING] unittests src/lib.rs (target/release/deps/foo-[HASH][EXE])

tests/testsuite/build.rs

@@ -471,8 +471,8 @@ fn cargo_compile_duplicate_build_targets() {
     p.cargo("build")
         .with_stderr_data(str![[r#"
 [WARNING] file `[ROOT]/foo/src/main.rs` found to be present in multiple build targets:
-  * `lib` target `main`
-  * `bin` target `foo`
+           * `lib` target `main`
+           * `bin` target `foo`
 [COMPILING] foo v0.0.1 ([ROOT]/foo)
 [FINISHED] `dev` profile [unoptimized + debuginfo] target(s) in [ELAPSED]s
 
@@ -1992,7 +1992,7 @@ fn many_crate_types_old_style_lib_location() {
     p.cargo("build")
         .with_stderr_data(str![[r#"
 [WARNING] path `src/foo.rs` was erroneously implicitly accepted for library `foo`,
-please rename the file to `src/lib.rs` or set lib.path in Cargo.toml
+         please rename the file to `src/lib.rs` or set lib.path in Cargo.toml
 [COMPILING] foo v0.5.0 ([ROOT]/foo)
 [FINISHED] `dev` profile [unoptimized + debuginfo] target(s) in [ELAPSED]s
 

tests/testsuite/build_script_env.rs

@@ -145,7 +145,7 @@ fn rustc_bootstrap() {
         .with_stderr_data(str![[r#"
 [COMPILING] has-dashes v0.0.1 ([ROOT]/foo)
 [WARNING] [email protected]: Cannot set `RUSTC_BOOTSTRAP=1` from build script of `has-dashes v0.0.1 ([ROOT]/foo)`.
-[NOTE] Crates cannot set `RUSTC_BOOTSTRAP` themselves, as doing so would subvert the stability guarantees of Rust for your project.
+         [NOTE] Crates cannot set `RUSTC_BOOTSTRAP` themselves, as doing so would subvert the stability guarantees of Rust for your project.
 [FINISHED] `dev` profile [unoptimized + debuginfo] target(s) in [ELAPSED]s
 
 "#]])
@@ -155,7 +155,7 @@ fn rustc_bootstrap() {
         .env("RUSTC_BOOTSTRAP", "has_dashes")
         .with_stderr_data(str![[r#"
 [WARNING] [email protected]: Cannot set `RUSTC_BOOTSTRAP=1` from build script of `has-dashes v0.0.1 ([ROOT]/foo)`.
-[NOTE] Crates cannot set `RUSTC_BOOTSTRAP` themselves, as doing so would subvert the stability guarantees of Rust for your project.
+         [NOTE] Crates cannot set `RUSTC_BOOTSTRAP` themselves, as doing so would subvert the stability guarantees of Rust for your project.
 [FINISHED] `dev` profile [unoptimized + debuginfo] target(s) in [ELAPSED]s
 
 "#]])
@@ -190,7 +190,7 @@ fn rustc_bootstrap() {
         .with_stderr_data(str![[r#"
 [COMPILING] foo v0.0.1 ([ROOT]/foo)
 [WARNING] [email protected]: Cannot set `RUSTC_BOOTSTRAP=1` from build script of `foo v0.0.1 ([ROOT]/foo)`.
-[NOTE] Crates cannot set `RUSTC_BOOTSTRAP` themselves, as doing so would subvert the stability guarantees of Rust for your project.
+         [NOTE] Crates cannot set `RUSTC_BOOTSTRAP` themselves, as doing so would subvert the stability guarantees of Rust for your project.
 [FINISHED] `dev` profile [unoptimized + debuginfo] target(s) in [ELAPSED]s
 
 "#]])

tests/testsuite/build_script_extra_link_arg.rs

@@ -222,8 +222,8 @@ fn cdylib_link_arg_transitive() {
 [RUNNING] `[ROOT]/foo/target/debug/build/bar-[HASH]/build-script-build`
 [WARNING] [email protected]: cargo::rustc-link-arg-cdylib was specified in the build script of bar v1.0.0 \
 ([ROOT]/foo/bar), but that package does not contain a cdylib target
-
-Allowing this was an unintended change in the 1.50 release, and may become an error in \
+         
+         Allowing this was an unintended change in the 1.50 release, and may become an error in \
 the future. For more information, see <https://github.com/rust-lang/cargo/issues/9562>.
 [RUNNING] `rustc --crate-name bar --edition=2015 bar/src/lib.rs [..]
 [COMPILING] foo v0.1.0 ([ROOT]/foo)