Rollback code

Author: baoyachi

src/gen_const.rs

@@ -2,7 +2,6 @@ use crate::{Shadow, CARGO_CLIPPY_ALLOW_ALL, CARGO_METADATA};
 
 macro_rules! gen_const {
     ($fn_name:ident, $fn_body:expr) => {
-        #[allow(unused)]
         pub fn $fn_name() -> String {
             let (doc, content) = $fn_body;
             format!(
@@ -16,7 +15,6 @@ macro_rules! gen_const {
     };
 }
 
-#[allow(dead_code)]
 const VERSION_BRANCH_CONST: (&str, &str) = (
     r#"/// A long version string describing the project.
 /// The version string contains the package version, branch, commit hash, build time, and build environment on separate lines.
@@ -30,7 +28,6 @@ build_env:{},{}"#,PKG_VERSION, BRANCH, SHORT_COMMIT, BUILD_TIME, RUST_VERSION, R
 );"##,
 );
 
-#[allow(dead_code)]
 const VERSION_TAG_CONST: (&str, &str) = (
     r#"/// A long version string describing the project.
 /// The version string contains the package version, current Git tag, commit hash, build time, and build environment on separate lines.
@@ -44,7 +41,6 @@ build_env:{},{}"#,PKG_VERSION, TAG, SHORT_COMMIT, BUILD_TIME, RUST_VERSION, RUST
 );"##,
 );
 
-#[allow(dead_code)]
 const CLAP_VERSION_BRANCH_CONST: (&str, &str) = (
     r#"#[deprecated = "Replaced with `CLAP_LONG_VERSION`"]"#,
     r##"pub const CLAP_VERSION:&str = shadow_rs::formatcp!(r#"{}
@@ -55,7 +51,6 @@ build_env:{},{}"#,PKG_VERSION, BRANCH, SHORT_COMMIT, BUILD_TIME, RUST_VERSION, R
 );"##,
 );
 
-#[allow(dead_code)]
 const CLAP_VERSION_TAG_CONST: (&str, &str) = (
     r#"#[deprecated = "Replaced with `CLAP_LONG_VERSION`"]"#,
     r##"pub const CLAP_VERSION:&str = shadow_rs::formatcp!(r#"{}
@@ -66,7 +61,6 @@ build_env:{},{}"#,PKG_VERSION, TAG, SHORT_COMMIT, BUILD_TIME, RUST_VERSION, RUST
 );"##,
 );
 
-#[allow(dead_code)]
 const CLAP_LONG_VERSION_BRANCH_CONST: (&str, &str) = (
     r#"/// A long version string describing the project.
 /// The version string contains the package version, branch, commit hash, build time, and build environment on separate lines.
@@ -79,7 +73,6 @@ build_env:{},{}"#,PKG_VERSION, BRANCH, SHORT_COMMIT, BUILD_TIME, RUST_VERSION, R
 );"##,
 );
 
-#[allow(dead_code)]
 const CLAP_LONG_VERSION_TAG_CONST: (&str, &str) = (
     r#"/// A long version string describing the project.
 /// The version string contains the package version, current Git tag, commit hash, build time, and build environment on separate lines.
@@ -102,9 +95,7 @@ gen_const!(
 );
 gen_const!(clap_long_version_tag_const, CLAP_LONG_VERSION_TAG_CONST);
 
-#[allow(dead_code)]
 pub(crate) const BUILD_CONST_VERSION: &str = "VERSION";
-#[allow(dead_code)]
 pub(crate) const BUILD_CONST_CLAP_LONG_VERSION: &str = "CLAP_LONG_VERSION";
 
 pub(crate) fn cargo_metadata_fn(shadow: &Shadow) -> String {

src/git.rs

@@ -367,7 +367,7 @@ pub fn branch() -> String {
     #[cfg(feature = "git2")]
     {
         use crate::git::git2_mod::{git2_current_branch, git_repo};
-        git_repo("../..")
+        git_repo(".")
             .map(|x| git2_current_branch(&x))
             .unwrap_or_else(|_| command_current_branch())
             .unwrap_or_default()
@@ -393,7 +393,7 @@ pub fn git_clean() -> bool {
     #[cfg(feature = "git2")]
     {
         use crate::git::git2_mod::git_repo;
-        git_repo("../..")
+        git_repo(".")
             .map(|x| Git::git2_dirty_stage(&x))
             .map(|x| x.trim().is_empty())
             .unwrap_or(true)
@@ -413,7 +413,7 @@ pub fn git_status_file() -> String {
     #[cfg(feature = "git2")]
     {
         use crate::git::git2_mod::git_repo;
-        git_repo("../..")
+        git_repo(".")
             .map(|x| Git::git2_dirty_stage(&x))
             .unwrap_or_default()
     }
@@ -437,7 +437,7 @@ struct GitCommandExecutor<'a> {
 
 impl Default for GitCommandExecutor<'_> {
     fn default() -> Self {
-        Self::new(Path::new("../.."))
+        Self::new(Path::new("."))
     }
 }
 
@@ -599,7 +599,7 @@ mod tests {
         #[cfg(feature = "git2")]
         {
             use crate::git::git2_mod::{git2_current_branch, git_repo};
-            let git2_branch = git_repo("../")
+            let git2_branch = git_repo(".")
                 .map(|x| git2_current_branch(&x))
                 .unwrap_or(None);
             let command_branch = command_current_branch();

src/lib.rs

@@ -194,6 +194,31 @@ const DEFINE_SHADOW_RS: &str = "shadow.rs";
 pub const CARGO_CLIPPY_ALLOW_ALL: &str =
     "#[allow(clippy::all, clippy::pedantic, clippy::restriction, clippy::nursery)]";
 
+/// Add a module with the provided name which contains the build information generated by `shadow-rs`.
+///
+/// # Example
+///
+/// ```ignore
+/// use shadow_rs::shadow;
+///
+/// shadow!(my_build_information);
+///
+/// fn main() {
+///     println!("I'm version {}!", my_build_information::VERSION);
+/// }
+/// ```
+///
+/// The convention, however, is to use `shadow!(build);`.
+#[macro_export]
+macro_rules! shadow {
+    ($build_mod:ident) => {
+        #[doc = r#"shadow-rs mod"#]
+        pub mod $build_mod {
+            include!(concat!(env!("OUT_DIR"), "/shadow.rs"));
+        }
+    };
+}
+
 /// Generates build information for the current project.
 /// This function must be called from `build.rs`.
 ///