Implement a command to dump impls for a given type (#7322)

This adds a new `--dump-impls` CLI command that can be used to dump all
the recognized trait impls for a given type name.

This also extends the compiler diagnostic system to allow the emission
of info diagnostics, as previously we could only emit either warnings of
errors, which did not fit this use case.

## Description

For example, here is the output of `cargo run --bin forc -- build --path
_test-case --dump-impls=std::string::String`:

<img width="677" height="958" alt="image"
src="https://github.com/user-attachments/assets/42aeca94-bbf9-4dff-8bb3-d1a70000999a"
/>

And for enums:

<img width="642" height="285" alt="image"
src="https://github.com/user-attachments/assets/ac565fea-9ebe-4f1d-a9a8-d022617d23d0"
/>

Closes #7286.


## Checklist

- [x] I have linked to any relevant issues.
- [x] I have commented my code, particularly in hard-to-understand
areas.
- [x] I have updated the documentation where relevant (API docs, the
reference, and the Sway book).
- [ ] If my change requires substantial documentation changes, I have
[requested support from the DevRel
team](https://github.com/FuelLabs/devrel-requests/issues/new/choose)
- [x] I have added tests that prove my fix is effective or that my
feature works.
- [x] I have added (or requested a maintainer to add) the necessary
`Breaking*` or `New Feature` labels where relevant.
- [x] I have done my best to ensure that my PR adheres to [the Fuel Labs
Code Review
Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md).
- [x] I have requested a review from the relevant team or maintainers.

Author: tritao

forc-pkg/src/manifest/build_profile.rs

@@ -1,6 +1,8 @@
 use serde::{Deserialize, Serialize};
 use sway_core::{Backtrace, OptLevel, PrintAsm, PrintIr};
 
+use crate::DumpOpts;
+
 /// Parameters to pass through to the `sway_core::BuildConfig` during compilation.
 #[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq)]
 #[serde(rename_all = "kebab-case")]
@@ -11,6 +13,7 @@ pub struct BuildProfile {
     pub print_ast: bool,
     pub print_dca_graph: Option<String>,
     pub print_dca_graph_url_format: Option<String>,
+    pub dump: DumpOpts,
     #[serde(default)]
     pub print_ir: PrintIr,
     #[serde(default)]
@@ -47,6 +50,7 @@ impl BuildProfile {
     pub fn debug() -> Self {
         Self {
             name: Self::DEBUG.into(),
+            dump: DumpOpts::default(),
             print_ast: false,
             print_dca_graph: None,
             print_dca_graph_url_format: None,
@@ -69,6 +73,7 @@ impl BuildProfile {
     pub fn release() -> Self {
         Self {
             name: Self::RELEASE.to_string(),
+            dump: DumpOpts::default(),
             print_ast: false,
             print_dca_graph: None,
             print_dca_graph_url_format: None,
@@ -101,7 +106,7 @@ impl Default for BuildProfile {
 
 #[cfg(test)]
 mod tests {
-    use crate::{BuildProfile, PackageManifest};
+    use crate::{BuildProfile, DumpOpts, PackageManifest};
     use sway_core::{Backtrace, OptLevel, PrintAsm, PrintIr};
 
     #[test]
@@ -154,6 +159,7 @@ mod tests {
         // Adapted release profile.
         let expected = BuildProfile {
             name: "".into(),
+            dump: DumpOpts::default(),
             print_ast: true,
             print_dca_graph: Some("dca_graph".into()),
             print_dca_graph_url_format: Some("print_dca_graph_url_format".into()),

forc-pkg/src/manifest/mod.rs

@@ -478,7 +478,7 @@ impl PackageManifestFile {
         let parse_res = parse_tree_type(&handler, entry_string);
 
         parse_res.map_err(|_| {
-            let (errors, _warnings) = handler.consume();
+            let (errors, _warnings, _infos) = handler.consume();
             parsing_failed(&self.project.name, &errors)
         })
     }

forc-pkg/src/pkg.rs

@@ -9,7 +9,7 @@ use anyhow::{anyhow, bail, Context, Error, Result};
 use byte_unit::{Byte, UnitType};
 use forc_tracing::{println_action_green, println_warning};
 use forc_util::{
-    default_output_directory, find_file_name, kebab_to_snake_case, print_compiling,
+    default_output_directory, find_file_name, kebab_to_snake_case, print_compiling, print_infos,
     print_on_failure, print_warnings,
 };
 use petgraph::{
@@ -279,12 +279,19 @@ pub struct MinifyOpts {
 /// Represents a compiled contract ID as a pub const in a contract.
 type ContractIdConst = String;
 
+#[derive(Serialize, Deserialize, Clone, Debug, Default, PartialEq, Eq)]
+pub struct DumpOpts {
+    /// Dump all trait implementations for the given type name.
+    pub dump_impls: Option<String>,
+}
+
 /// The set of options provided to the `build` functions.
 #[derive(Default, Clone)]
 pub struct BuildOpts {
     pub pkg: PkgOpts,
     pub print: PrintOpts,
     pub minify: MinifyOpts,
+    pub dump: DumpOpts,
     /// If set, generates a JSON file containing the hex-encoded script binary.
     pub hex_outfile: Option<String>,
     /// If set, outputs a binary file representing the script bytes.
@@ -1701,10 +1708,11 @@ pub fn compile(
     let terse_mode = profile.terse;
     let reverse_results = profile.reverse_results;
     let fail = |handler: Handler| {
-        let (errors, warnings) = handler.consume();
+        let (errors, warnings, infos) = handler.consume();
         print_on_failure(
             engines.se(),
             terse_mode,
+            &infos,
             &warnings,
             &errors,
             reverse_results,
@@ -1724,7 +1732,7 @@ pub fn compile(
             &handler,
             engines,
             source,
-            namespace,
+            namespace.clone(),
             Some(&sway_build_config),
             &pkg.name,
             None,
@@ -1754,6 +1762,15 @@ pub fn compile(
         return fail(handler);
     }
 
+    if let Some(typename) = &profile.dump.dump_impls {
+        let _ = sway_core::dump_trait_impls_for_typename(
+            &handler,
+            engines,
+            &typed_program.namespace,
+            typename,
+        );
+    }
+
     let asm_res = time_expr!(
         pkg.name,
         "compile ast to asm",
@@ -1862,8 +1879,9 @@ pub fn compile(
         _ => return fail(handler),
     };
 
-    let (_, warnings) = handler.consume();
+    let (_, warnings, infos) = handler.consume();
 
+    print_infos(engines.se(), terse_mode, &infos);
     print_warnings(engines.se(), terse_mode, &pkg.name, &warnings, &tree_type);
 
     // Metadata to be placed into the binary.
@@ -2108,6 +2126,7 @@ fn build_profile_from_opts(
         metrics_outfile,
         tests,
         error_on_warnings,
+        dump,
         ..
     } = build_options;
 
@@ -2128,6 +2147,7 @@ fn build_profile_from_opts(
             BuildProfile::default()
         });
     profile.name = selected_profile_name.into();
+    profile.dump = dump.clone();
     profile.print_ast |= print.ast;
     if profile.print_dca_graph.is_none() {
         profile.print_dca_graph.clone_from(&print.dca_graph);
@@ -2420,10 +2440,11 @@ pub fn build(
             manifest_file: manifest.clone(),
         };
 
-        let fail = |warnings, errors| {
+        let fail = |infos, warnings, errors| {
             print_on_failure(
                 engines.se(),
                 profile.terse,
+                infos,
                 warnings,
                 errors,
                 profile.reverse_results,
@@ -2467,7 +2488,7 @@ pub fn build(
                 dbg_generation,
             ) {
                 Ok(o) => o,
-                Err(errs) => return fail(&[], &errs),
+                Err(errs) => return fail(&[], &[], &errs),
             };
 
             let compiled_without_tests = compile(
@@ -2544,6 +2565,7 @@ pub fn build(
                     engines.se(),
                     profile.terse,
                     &[],
+                    &[],
                     &errs,
                     profile.reverse_results,
                 );

forc-pkg/tests/sections/Forc.toml

@@ -7,6 +7,7 @@ name = "sections"
 [dependencies]
 
 [build-profile.release]
+dump = {}
 print-ast = true
 print-dca-graph = "dca_graph"
 print-dca-graph-url-format = "print_dca_graph_url_format"
@@ -23,13 +24,16 @@ optimization-level = 0
 backtrace = "none"
 
 [build-profile.custom_asm]
+dump = {}
 print-asm = { virtual = false, allocated = false, final = true }
 
 [build-profile.custom_ir]
+dump = {}
 print-ir = { initial = true, final = false, modified = true, passes = [
     "dce",
     "sroa",
 ] }
 
 [build-profile.custom_backtrace]
 backtrace = "only_always"
+dump = {}

forc-plugins/forc-client/src/op/deploy.rs

@@ -12,7 +12,7 @@ use crate::{
     },
 };
 use anyhow::{bail, Context, Result};
-use forc_pkg::{self as pkg, PackageManifestFile};
+use forc_pkg::{self as pkg, DumpOpts, PackageManifestFile};
 use forc_pkg::{manifest::GenericManifestFile, MemberFilter};
 use forc_tracing::{println_action_green, println_warning};
 use forc_util::default_output_directory;
@@ -814,6 +814,7 @@ fn build_opts_from_cmd(cmd: &cmd::Deploy, member_filter: pkg::MemberFilter) -> p
             ir: cmd.print.ir(),
             reverse_order: cmd.print.reverse_order,
         },
+        dump: DumpOpts::default(),
         time_phases: cmd.print.time_phases,
         profile: cmd.print.profile,
         metrics_outfile: cmd.print.metrics_outfile.clone(),

forc-plugins/forc-client/src/op/run/mod.rs

@@ -8,7 +8,7 @@ use crate::{
     },
 };
 use anyhow::{anyhow, bail, Context, Result};
-use forc_pkg::{self as pkg, fuel_core_not_running, PackageManifestFile};
+use forc_pkg::{self as pkg, fuel_core_not_running, DumpOpts, PackageManifestFile};
 use forc_tracing::println_warning;
 use forc_util::tx_utils::format_log_receipts;
 use fuel_abi_types::abi::program::ProgramABI;
@@ -319,6 +319,7 @@ fn build_opts_from_cmd(cmd: &cmd::Run) -> pkg::BuildOpts {
             json_abi: cmd.minify.json_abi,
             json_storage_slots: cmd.minify.json_storage_slots,
         },
+        dump: DumpOpts::default(),
         build_target: BuildTarget::default(),
         build_profile: cmd.build_profile.build_profile.clone(),
         release: cmd.build_profile.release,

forc-test/src/lib.rs

@@ -7,7 +7,7 @@ use crate::setup::{
     ContractDeploymentSetup, ContractTestSetup, DeploymentSetup, ScriptTestSetup, TestSetup,
 };
 use ecal::EcalSyscallHandler;
-use forc_pkg::{self as pkg, BuildOpts};
+use forc_pkg::{self as pkg, BuildOpts, DumpOpts};
 use forc_util::tx_utils::RevertInfo;
 use fuel_abi_types::abi::program::ProgramABI;
 use fuel_tx as tx;
@@ -452,6 +452,7 @@ impl From<TestOpts> for pkg::BuildOpts {
             pkg: val.pkg,
             print: val.print,
             minify: val.minify,
+            dump: DumpOpts::default(),
             binary_outfile: val.binary_outfile,
             debug_outfile: val.debug_outfile,
             hex_outfile: val.hex_outfile,
@@ -477,6 +478,7 @@ impl TestOpts {
             pkg: self.pkg,
             print: self.print,
             minify: self.minify,
+            dump: DumpOpts::default(),
             binary_outfile: self.binary_outfile,
             debug_outfile: self.debug_outfile,
             hex_outfile: self.hex_outfile,

forc-util/src/lib.rs

@@ -18,7 +18,7 @@ use sway_core::language::parsed::TreeType;
 use sway_error::{
     diagnostic::{Diagnostic, Issue, Label, LabelType, Level, ToDiagnostic},
     error::CompileError,
-    warning::CompileWarning,
+    warning::{CompileInfo, CompileWarning},
 };
 use sway_types::{LineCol, LineColRange, SourceEngine, Span};
 use sway_utils::constants;
@@ -295,6 +295,18 @@ pub fn print_compiling(ty: Option<&TreeType>, name: &str, src: &dyn std::fmt::Di
     );
 }
 
+pub fn print_infos(source_engine: &SourceEngine, terse_mode: bool, infos: &[CompileInfo]) {
+    if infos.is_empty() {
+        return;
+    }
+
+    if !terse_mode {
+        infos
+            .iter()
+            .for_each(|n| format_diagnostic(&n.to_diagnostic(source_engine)));
+    }
+}
+
 pub fn print_warnings(
     source_engine: &SourceEngine,
     terse_mode: bool,
@@ -329,10 +341,13 @@ pub fn print_warnings(
 pub fn print_on_failure(
     source_engine: &SourceEngine,
     terse_mode: bool,
+    infos: &[CompileInfo],
     warnings: &[CompileWarning],
     errors: &[CompileError],
     reverse_results: bool,
 ) {
+    print_infos(source_engine, terse_mode, infos);
+
     let e_len = errors.len();
     let w_len = warnings.len();
 

forc/src/cli/commands/check.rs

@@ -45,6 +45,10 @@ pub struct Command {
     #[clap(long)]
     pub ipfs_node: Option<IPFSNode>,
 
+    /// Dump all trait implementations for the given type name.
+    #[clap(long = "dump-impls", value_name = "TYPE")]
+    pub dump_impls: Option<String>,
+
     #[clap(flatten)]
     pub experimental: sway_features::CliFields,
 }

forc/src/cli/shared.rs

@@ -91,6 +91,8 @@ pub struct Build {
     /// Build target to use for code generation.
     #[clap(long, value_enum, default_value_t = BuildTarget::default(), alias="target")]
     pub build_target: BuildTarget,
+    #[clap(flatten)]
+    pub dump: Dump,
 }
 
 /// Build output file options.
@@ -126,6 +128,14 @@ pub struct BuildProfile {
     pub error_on_warnings: bool,
 }
 
+/// Dump options.
+#[derive(Args, Debug, Default)]
+pub struct Dump {
+    /// Dump all trait implementations for the given type name.
+    #[clap(long = "dump-impls", value_name = "TYPE")]
+    pub dump_impls: Option<String>,
+}
+
 /// Options related to printing stages of compiler output.
 #[derive(Args, Debug, Default)]
 pub struct Print {