fix(shell): Switch to annotate snippets for warnings

This is part of #15944

Author: epage

src/cargo/core/shell.rs

@@ -222,7 +222,10 @@ 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.

tests/testsuite/bad_config.rs

@@ -962,7 +962,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
@@ -1077,7 +1077,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
@@ -1185,7 +1185,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
 
@@ -1276,7 +1276,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
 
@@ -1385,9 +1385,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
 
@@ -1524,7 +1524,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)
@@ -1655,7 +1655,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
@@ -1784,7 +1784,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)
@@ -1959,7 +1959,7 @@ fn workspace_default_features2() {
 [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)
+         (in the `dep_workspace_only` dependency)
 
 "#]]
             .unordered(),
@@ -2070,7 +2070,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
 
@@ -2158,7 +2158,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
 
@@ -3596,22 +3596,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 [..]`
@@ -3641,22 +3641,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 [..]`
@@ -3685,7 +3685,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:
+         
+         * benches/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/cargo_features.rs

@@ -263,7 +263,7 @@ fn stable_feature_warns() {
     p.cargo("check")
         .with_stderr_data(str![[r#"
 [WARNING] the cargo feature `test-dummy-stable` has been stabilized in the 1.0 release and is no longer necessary to be listed in the manifest
-  See https://doc.rust-lang.org/cargo/ for more information about using this feature.
+           See https://doc.rust-lang.org/cargo/ for more information about using this feature.
 [CHECKING] a v0.0.1 ([ROOT]/foo)
 [FINISHED] `dev` profile [unoptimized + debuginfo] target(s) in [ELAPSED]s
 
@@ -753,8 +753,8 @@ fn z_stabilized() {
         .masquerade_as_nightly_cargo(&["always_nightly"])
         .with_stderr_data(str![[r#"
 [WARNING] flag `-Z cache-messages` has been stabilized in the 1.40 release, and is no longer necessary
-  Message caching is now always enabled.
-
+           Message caching is now always enabled.
+         
 [CHECKING] foo v0.0.1 ([ROOT]/foo)
 [FINISHED] `dev` profile [unoptimized + debuginfo] target(s) in [ELAPSED]s
 

tests/testsuite/cargo_init/path_contains_separator/stderr.term.svg

@@ -448,20 +448,20 @@ fn no_fail_bad_lib() {
 [CHECKING] foo v0.0.1 ([ROOT]/foo)
 [SCRAPING] foo v0.0.1 ([ROOT]/foo)
 [WARNING] failed to check lib in package `foo` as a prerequisite for scraping examples from: example "ex", example "ex2"
-    Try running with `--verbose` to see the error message.
-    If an example should not be scanned, then consider adding `doc-scrape-examples = false` to its `[[example]]` definition in Cargo.toml
 [WARNING] `foo` (lib) generated 1 warning
 [WARNING] failed to scan example "ex" in package `foo` for example code usage
-    Try running with `--verbose` to see the error message.
-    If an example should not be scanned, then consider adding `doc-scrape-examples = false` to its `[[example]]` definition in Cargo.toml
 [WARNING] `foo` (example "ex") generated 1 warning
 [WARNING] failed to scan example "ex2" in package `foo` for example code usage
-    Try running with `--verbose` to see the error message.
-    If an example should not be scanned, then consider adding `doc-scrape-examples = false` to its `[[example]]` definition in Cargo.toml
 [WARNING] `foo` (example "ex2") generated 1 warning
 [DOCUMENTING] foo v0.0.1 ([ROOT]/foo)
 [FINISHED] `dev` profile [unoptimized + debuginfo] target(s) in [ELAPSED]s
 [GENERATED] [ROOT]/foo/target/doc/foo/index.html
+             Try running with `--verbose` to see the error message.
+             If an example should not be scanned, then consider adding `doc-scrape-examples = false` to its `[[example]]` definition in Cargo.toml
+             Try running with `--verbose` to see the error message.
+             If an example should not be scanned, then consider adding `doc-scrape-examples = false` to its `[[example]]` definition in Cargo.toml
+             Try running with `--verbose` to see the error message.
+             If an example should not be scanned, then consider adding `doc-scrape-examples = false` to its `[[example]]` definition in Cargo.toml
 
 "#]].unordered())
         .run();
@@ -531,8 +531,8 @@ fn no_fail_bad_example() {
 [CHECKING] foo v0.0.1 ([ROOT]/foo)
 [SCRAPING] foo v0.0.1 ([ROOT]/foo)
 [WARNING] failed to scan example "ex1" in package `foo` for example code usage
-    Try running with `--verbose` to see the error message.
-    If an example should not be scanned, then consider adding `doc-scrape-examples = false` to its `[[example]]` definition in Cargo.toml
+             Try running with `--verbose` to see the error message.
+             If an example should not be scanned, then consider adding `doc-scrape-examples = false` to its `[[example]]` definition in Cargo.toml
 [WARNING] `foo` (example "ex1") generated 1 warning
 [DOCUMENTING] foo v0.0.1 ([ROOT]/foo)
 [FINISHED] `dev` profile [unoptimized + debuginfo] target(s) in [ELAPSED]s
@@ -614,8 +614,8 @@ fn no_scrape_with_dev_deps() {
         .with_stderr_data(str![[r#"
 [LOCKING] 1 package to latest compatible version
 [WARNING] Rustdoc did not scrape the following examples because they require dev-dependencies: ex
-    If you want Rustdoc to scrape these examples, then add `doc-scrape-examples = true`
-    to the [[example]] target configuration of at least one example.
+             If you want Rustdoc to scrape these examples, then add `doc-scrape-examples = true`
+             to the [[example]] target configuration of at least one example.
 [DOCUMENTING] foo v0.0.1 ([ROOT]/foo)
 [FINISHED] `dev` profile [unoptimized + debuginfo] target(s) in [ELAPSED]s
 [GENERATED] [ROOT]/foo/target/doc/foo/index.html