1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
//! `shadow-rs` is a build script write by Rust //! //! It's can record compiled project much information. //! Like version info,dependence info.Like shadow,if compiled,never change.forever follow your project. //! //! Generated rust const by exec:`cargo build` //! //! # Example //! //! ``` //! pub const RUST_VERSION :&str = "rustc 1.45.0 (5c1f21c3b 2020-07-13)"; //! pub const BUILD_RUST_CHANNEL :&str = "debug"; //! pub const COMMIT_AUTHOR :&str = "baoyachi"; //! pub const BUILD_TIME :&str = "2020-08-16 13:48:52"; //! pub const COMMIT_DATE :&str = "2020-08-16 13:12:52"; //! pub const COMMIT_EMAIL :&str = "xxx@gmail.com"; //! pub const PROJECT_NAME :&str = "shadow-rs"; //! pub const RUST_CHANNEL :&str = "stable-x86_64-apple-darwin (default)"; //! pub const BRANCH :&str = "master"; //! pub const CARGO_LOCK :&str = r#" //! ├── chrono v0.4.19 //! │ ├── libc v0.2.80 //! │ ├── num-integer v0.1.44 //! │ │ └── num-traits v0.2.14 //! │ │ [build-dependencies] //! │ │ └── autocfg v1.0.1 //! │ ├── num-traits v0.2.14 (*) //! │ └── time v0.1.44 //! │ └── libc v0.2.80 //! └── git2 v0.13.12 //! ├── log v0.4.11 //! │ └── cfg-if v0.1.10 //! └── url v2.2.0 //! ├── form_urlencoded v1.0.0 //! │ └── percent-encoding v2.1.0 //! └── percent-encoding v2.1.0"#; //! pub const CARGO_VERSION :&str = "cargo 1.45.0 (744bd1fbb 2020-06-15)"; //! pub const BUILD_OS :&str = "macos-x86_64"; //! pub const COMMIT_HASH :&str = "386741540d73c194a3028b96b92fdeb53ca2788a"; //! pub const PKG_VERSION :&str = "0.3.13"; //! ``` //! # Quick Start //! //! ## step 1 //! In your `cargo.toml` `packgae` with package add with below config //! //! ```toml //! [package] //! build = "build.rs" //! //! [dependencies] //! shadow-rs = "0.4" //! //! [build-dependencies] //! shadow-rs = "0.4" //! ``` //! //! ## step 2 //! In your project add file `build.rs`,then add with below config //! //! ```ignore //! fn main() -> shadow_rs::SdResult<()> { //! shadow_rs::Shadow::new() //! } //! ``` //! //! ## step 3 //! In your project find `bin` rust file.It's usually `main.rs`, you can find `[bin]` file with `Cargo.toml`,then add with below config //! The `shadow!(build)` with `build` config,add Rust build mod in your project. You can also replace it(build) with other name. //! //! ```ignore //! #[macro_use] //! extern crate shadow_rs; //! //! shadow!(build); //! ``` //! //! ## step 4 //! Then you can use const that's shadow build it(main.rs). //! //! The `build` mod just we use `shadow!(build)` generated. //! //! ```ignore //! fn main(){ //! println!("{}",build::BRANCH); //master //! println!("{}",build::SHORT_COMMIT);//8405e28e //! println!("{}",build::COMMIT_HASH);//8405e28e64080a09525a6cf1b07c22fcaf71a5c5 //! println!("{}",build::COMMIT_DATE);//2020-08-16T06:22:24+00:00 //! println!("{}",build::COMMIT_AUTHOR);//baoyachi //! println!("{}",build::COMMIT_EMAIL);//xxx@gmail.com //! //! println!("{}",build::BUILD_OS);//macos-x86_64 //! println!("{}",build::RUST_VERSION);//rustc 1.45.0 (5c1f21c3b 2020-07-13) //! println!("{}",build::RUST_CHANNEL);//stable-x86_64-apple-darwin (default) //! println!("{}",build::CARGO_VERSION);//cargo 1.45.0 (744bd1fbb 2020-06-15) //! println!("{}",build::PKG_VERSION);//0.3.13 //! println!("{}",build::CARGO_TREE); //like command:cargo tree //! //! println!("{}",build::PROJECT_NAME);//shadow-rs //! println!("{}",build::BUILD_TIME);//2020-08-16 14:50:25 //! println!("{}",build::BUILD_RUST_CHANNEL);//debug //! } //!``` //! //! ## Clap example //! And you can also use const with [clap](https://github.com/baoyachi/shadow-rs/blob/master/example_shadow/src/main.rs#L25_L27). //! //! For the user guide and futher documentation, please read //! [The shadow-rs document](https://github.com/baoyachi/shadow-rs). //! mod build; pub mod channel; mod ci; mod env; pub mod err; mod git; use build::*; use env::*; use git::*; use crate::ci::CIType; use std::cell::RefCell; use std::collections::HashMap; use std::env as std_env; use std::fs::File; use std::io::Write; use std::path::Path; use chrono::Local; pub use err::{SdResult, ShadowError}; const SHADOW_RS: &str = "shadow.rs"; /// Add a mod in project with `$build_mod`. /// /// You can use `shadow!(build_shadow)`. Then shadow-rs can help you add a mod with name `build_shadow`. /// Next, use mod with name `build_shadow`,and also use const like:`build_shadow::BRANCH`. /// /// Normally, you just config `shadow!(build)`.It looks more concise. #[macro_export] macro_rules! shadow { ($build_mod:ident) => { pub mod $build_mod { include!(concat!(env!("OUT_DIR"), "/shadow.rs")); } }; } #[derive(Debug)] pub struct Shadow { f: File, map: HashMap<ShadowConst, RefCell<ConstVal>>, std_env: HashMap<String, String>, } impl Shadow { fn get_env() -> HashMap<String, String> { let mut env_map = HashMap::new(); for (k, v) in std_env::vars() { env_map.insert(k, v); } env_map } /// try get current ci env fn try_ci(&self) -> CIType { if let Some(c) = self.std_env.get("GITLAB_CI") { if c == "true" { return CIType::Gitlab; } } if let Some(c) = self.std_env.get("GITHUB_ACTIONS") { if c == "true" { return CIType::Github; } } //TODO completed [travis,jenkins] env CIType::None } pub fn new() -> SdResult<()> { let src_path = std::env::var("CARGO_MANIFEST_DIR")?; let out_path = std::env::var("OUT_DIR")?; Self::build(src_path, out_path) } pub fn build(src_path: String, out_path: String) -> SdResult<()> { let out = { let path = Path::new(out_path.as_str()); if !out_path.ends_with('/') { path.join(format!("{}/{}", out_path, SHADOW_RS)) } else { path.join(SHADOW_RS) } }; let mut shadow = Shadow { f: File::create(out)?, map: Default::default(), std_env: Default::default(), }; shadow.std_env = Self::get_env(); let ci_type = shadow.try_ci(); let src_path = Path::new(src_path.as_str()); let mut map = new_git(&src_path, ci_type, &shadow.std_env); for (k, v) in new_project(&shadow.std_env) { map.insert(k, v); } for (k, v) in new_system_env(&shadow.std_env) { map.insert(k, v); } shadow.map = map; shadow.gen_const()?; println!("shadow build success"); Ok(()) } fn gen_const(&mut self) -> SdResult<()> { self.write_header()?; for (k, v) in self.map.clone() { self.write_const(k, v)?; } Ok(()) } fn write_header(&self) -> SdResult<()> { let desc = format!( r#"/// Code generated by shadow-rs generator. DO NOT EDIT. /// Author by:https://www.github.com/baoyachi /// The build script repository:https://github.com/baoyachi/shadow-rs /// create time by:{}"#, Local::now().format("%Y-%m-%d %H:%M:%S").to_string() ); writeln!(&self.f, "{}\n\n", desc)?; Ok(()) } fn write_const(&mut self, shadow_const: ShadowConst, val: RefCell<ConstVal>) -> SdResult<()> { let val = val.into_inner(); let desc = format!("/// {}", val.desc); let (t, v) = match val.t { ConstType::OptStr => (ConstType::Str.to_string(), "".into()), ConstType::Str => (ConstType::Str.to_string(), val.v), }; let define = format!( "pub const {} :{} = r#\"{}\"#;", shadow_const.to_ascii_uppercase(), t, v ); writeln!(&self.f, "{}", desc)?; writeln!(&self.f, "{}\n", define)?; Ok(()) } } #[cfg(test)] mod tests { use super::*; #[test] fn test_build() -> SdResult<()> { Shadow::build("./".into(), "./".into())?; Ok(()) } }