qualify all references in macros

mitsuhiko · Feb 25, 2025 · 096b77a · 096b77a
1 parent b6ecee1
commit 096b77a
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 14 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,7 @@ All notable changes to insta and cargo-insta are documented here.
 - Support specifying `cargo-nextest` bin with `INSTA_CARGO_NEXTEST_BIN`.  #721 (Louis Fruleux)
 - Allow setting `INSTA_WORKSPACE_ROOT` at compile time. This is useful for reproducible binaries
   so they don't contain references to `CARGO_MANIFEST_DIR`. #726 (Pascal Bach)
+- Qualify all references in macros to avoid name clashes. #728 (Austin Schey)
 
 ## 1.42.3
 

diff --git a/insta/src/lib.rs b/insta/src/lib.rs
@@ -350,6 +350,8 @@ pub mod _macro_support {
         assert_snapshot, with_allow_duplicates, AutoName, BinarySnapshotValue, InlineValue,
         SnapshotValue,
     };
+    pub use core::{file, line, module_path};
+    pub use std::{any, env, format, option_env, path, vec};
 
     #[cfg(feature = "serde")]
     pub use crate::serialization::{serialize_value, SerializationFormat, SnapshotLocation};

diff --git a/insta/src/macros.rs b/insta/src/macros.rs
@@ -5,7 +5,7 @@ macro_rules! _function_name {
     () => {{
         fn f() {}
         fn type_name_of_val<T>(_: T) -> &'static str {
-            std::any::type_name::<T>()
+            $crate::_macro_support::any::type_name::<T>()
         }
         let mut name = type_name_of_val(f).strip_suffix("::f").unwrap_or("");
         while let Some(rest) = name.strip_suffix("::{{closure}}") {
@@ -19,7 +19,7 @@ macro_rules! _function_name {
 #[macro_export]
 macro_rules! _get_workspace_root {
     () => {{
-        use std::{env, option_env};
+        use $crate::_macro_support::{env, option_env};
 
         // Note the `env!("CARGO_MANIFEST_DIR")` needs to be in the macro (in
         // contrast to a function in insta) because the macro needs to capture
@@ -278,7 +278,7 @@ macro_rules! _assert_serialized_snapshot {
 macro_rules! _prepare_snapshot_for_redaction {
     ($value:expr, {$($k:expr => $v:expr),*}, $format:ident) => {
         {
-            let vec = std::vec![
+            let vec = $crate::_macro_support::vec![
                 $((
                     $crate::_macro_support::Selector::parse($k).unwrap(),
                     $crate::_macro_support::Redaction::from($v)
@@ -315,7 +315,7 @@ macro_rules! _prepare_snapshot_for_redaction {
 #[macro_export]
 macro_rules! assert_debug_snapshot {
     ($($arg:tt)*) => {
-        $crate::_assert_snapshot_base!(transform=|v| std::format!("{:#?}", v), $($arg)*)
+        $crate::_assert_snapshot_base!(transform=|v| $crate::_macro_support::format!("{:#?}", v), $($arg)*)
     };
 }
 
@@ -329,7 +329,7 @@ macro_rules! assert_debug_snapshot {
 #[macro_export]
 macro_rules! assert_compact_debug_snapshot {
     ($($arg:tt)*) => {
-        $crate::_assert_snapshot_base!(transform=|v| std::format!("{:?}", v), $($arg)*)
+        $crate::_assert_snapshot_base!(transform=|v| $crate::_macro_support::format!("{:?}", v), $($arg)*)
     };
 }
 
@@ -374,9 +374,9 @@ macro_rules! _assert_snapshot_base {
             ).into(),
             $crate::_get_workspace_root!().as_path(),
             $crate::_function_name!(),
-            module_path!(),
-            file!(),
-            line!(),
+            $crate::_macro_support::module_path!(),
+            $crate::_macro_support::file!(),
+            $crate::_macro_support::line!(),
             $debug_expr,
         )
         .unwrap()
@@ -417,9 +417,9 @@ macro_rules! assert_binary_snapshot {
             .into(),
             $crate::_get_workspace_root!().as_path(),
             $crate::_function_name!(),
-            module_path!(),
-            file!(),
-            line!(),
+            $crate::_macro_support::module_path!(),
+            $crate::_macro_support::file!(),
+            $crate::_macro_support::line!(),
             $debug_expr,
         )
         .unwrap()
@@ -458,7 +458,7 @@ macro_rules! assert_display_snapshot {
 #[macro_export]
 macro_rules! assert_snapshot {
     ($($arg:tt)*) => {
-        $crate::_assert_snapshot_base!(transform=|v| std::format!("{}", v), $($arg)*)
+        $crate::_assert_snapshot_base!(transform=|v| $crate::_macro_support::format!("{}", v), $($arg)*)
     };
 }
 
@@ -555,7 +555,7 @@ macro_rules! glob {
     // and just support a pattern such as
     // `glob!("../test_data/inputs/*.txt"...`.
     ($base_path:expr, $glob:expr, $closure:expr) => {{
-        use std::path::Path;
+        use $crate::_macro_support::path::Path;
 
         let base = $crate::_get_workspace_root!()
             .join(Path::new(file!()).parent().unwrap())
@@ -574,7 +574,7 @@ macro_rules! glob {
     }};
 
     ($glob:expr, $closure:expr) => {{
-        insta::glob!(".", $glob, $closure)
+        $crate::glob!(".", $glob, $closure)
     }};
 }