bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Merge commit '4bdfb0741d' into clippyup

Browse source
This commit is contained in:
Philipp Krones 2022-12-17 14:12:54 +01:00
parent cfe1e040e7
commit 1c422524c7
127 changed files with 2710 additions and 605 deletions
Download patch file Download diff file Expand all files Collapse all files

6
rustc_tools_util/CHANGELOG.md Normal file
View file

@ -0,0 +1,6 @@
# Changelog
## Version 0.3.0
* Added `setup_version_info!();` macro for automated scripts.
* `get_version_info!()` no longer requires the user to import `rustc_tools_util::VersionInfo` and `std::env`

2
rustc_tools_util/Cargo.toml
View file

@ -1,6 +1,6 @@
[package]
name = "rustc_tools_util"
version = "0.2.1"
version = "0.3.0"
description = "small helper to generate version information for git packages"
repository = "https://github.com/rust-lang/rust-clippy"
readme = "README.md"

42
rustc_tools_util/README.md
View file

@ -13,43 +13,39 @@ build = "build.rs"
List rustc_tools_util as regular AND build dependency.
````toml
[dependencies]
rustc_tools_util = "0.2.1"
rustc_tools_util = "0.3.0"
[build-dependencies]
rustc_tools_util = "0.2.1"
rustc_tools_util = "0.3.0"
````
In `build.rs`, generate the data in your `main()`
````rust
fn main() {
println!(
"cargo:rustc-env=GIT_HASH={}",
rustc_tools_util::get_commit_hash().unwrap_or_default()
);
println!(
"cargo:rustc-env=COMMIT_DATE={}",
rustc_tools_util::get_commit_date().unwrap_or_default()
);
println!(
"cargo:rustc-env=RUSTC_RELEASE_CHANNEL={}",
rustc_tools_util::get_channel().unwrap_or_default()
);
}
````
```rust
fn main() {
rustc_tools_util::setup_version_info!();
}
```
Use the version information in your main.rs
````rust
use rustc_tools_util::*;
```rust
fn show_version() {
let version_info = rustc_tools_util::get_version_info!();
println!("{}", version_info);
}
````
This gives the following output in clippy:
`clippy 0.0.212 (a416c5e 2018-12-14)`
```
This gives the following output in clippy:
`clippy 0.1.66 (a28f3c8 2022-11-20)`
## Repository
This project is part of the rust-lang/rust-clippy repository. The source code
can be found under `./rustc_tools_util/`.
The changelog for `rustc_tools_util` is available under:
[`rustc_tools_util/CHANGELOG.md`](https://github.com/rust-lang/rust-clippy/blob/master/rustc_tools_util/CHANGELOG.md)
## License

48
rustc_tools_util/src/lib.rs
View file

@ -1,20 +1,20 @@
#![cfg_attr(feature = "deny-warnings", deny(warnings))]
use std::env;
/// This macro creates the version string during compilation from the
/// current environment
#[macro_export]
macro_rules! get_version_info {
() => {{
let major = env!("CARGO_PKG_VERSION_MAJOR").parse::<u8>().unwrap();
let minor = env!("CARGO_PKG_VERSION_MINOR").parse::<u8>().unwrap();
let patch = env!("CARGO_PKG_VERSION_PATCH").parse::<u16>().unwrap();
let crate_name = String::from(env!("CARGO_PKG_NAME"));
let major = std::env!("CARGO_PKG_VERSION_MAJOR").parse::<u8>().unwrap();
let minor = std::env!("CARGO_PKG_VERSION_MINOR").parse::<u8>().unwrap();
let patch = std::env!("CARGO_PKG_VERSION_PATCH").parse::<u16>().unwrap();
let crate_name = String::from(std::env!("CARGO_PKG_NAME"));
let host_compiler = option_env!("RUSTC_RELEASE_CHANNEL").map(str::to_string);
let commit_hash = option_env!("GIT_HASH").map(str::to_string);
let commit_date = option_env!("COMMIT_DATE").map(str::to_string);
let host_compiler = std::option_env!("RUSTC_RELEASE_CHANNEL").map(str::to_string);
let commit_hash = std::option_env!("GIT_HASH").map(str::to_string);
let commit_date = std::option_env!("COMMIT_DATE").map(str::to_string);
VersionInfo {
$crate::VersionInfo {
major,
minor,
patch,
@ -26,6 +26,24 @@ macro_rules! get_version_info {
}};
}
/// This macro can be used in `build.rs` to automatically set the needed
/// environment values, namely `GIT_HASH`, `COMMIT_DATE` and
/// `RUSTC_RELEASE_CHANNEL`
#[macro_export]
macro_rules! setup_version_info {
() => {{
println!(
"cargo:rustc-env=GIT_HASH={}",
$crate::get_commit_hash().unwrap_or_default()
);
println!(
"cargo:rustc-env=COMMIT_DATE={}",
$crate::get_commit_date().unwrap_or_default()
);
println!("cargo:rustc-env=RUSTC_RELEASE_CHANNEL={}", $crate::get_channel());
}};
}
// some code taken and adapted from RLS and cargo
pub struct VersionInfo {
pub major: u8,
@ -101,7 +119,7 @@ pub fn get_commit_date() -> Option<String> {
#[must_use]
pub fn get_channel() -> String {
match env::var("CFG_RELEASE_CHANNEL") {
match std::env::var("CFG_RELEASE_CHANNEL") {
Ok(channel) => channel,
Err(_) => {
// if that failed, try to ask rustc -V, do some parsing and find out
@ -136,8 +154,8 @@ mod test {
fn test_struct_local() {
let vi = get_version_info!();
assert_eq!(vi.major, 0);
assert_eq!(vi.minor, 2);
assert_eq!(vi.patch, 1);
assert_eq!(vi.minor, 3);
assert_eq!(vi.patch, 0);
assert_eq!(vi.crate_name, "rustc_tools_util");
// hard to make positive tests for these since they will always change
assert!(vi.commit_hash.is_none());
@ -147,7 +165,7 @@ mod test {
#[test]
fn test_display_local() {
let vi = get_version_info!();
assert_eq!(vi.to_string(), "rustc_tools_util 0.2.1");
assert_eq!(vi.to_string(), "rustc_tools_util 0.3.0");
}
#[test]
@ -156,7 +174,7 @@ mod test {
let s = format!("{vi:?}");
assert_eq!(
s,
"VersionInfo { crate_name: \"rustc_tools_util\", major: 0, minor: 2, patch: 1 }"
"VersionInfo { crate_name: \"rustc_tools_util\", major: 0, minor: 3, patch: 0 }"
);
}
}