There are some tests in the rustfmt test suite that are ignored by default. I believe these tests are ignored because they have caused issues with the the `rust-lang/rust` test suite. However, we recently experienced an issue (5395) that would have been avoided had these tests been running. With the introduction of the new `#[rustfmt_only_ci_test]` attribute macro we can run these tests when the `RUSTFMT_CI` environment variable is set, which will presumably only be set during rustfmts CI runs. When the environment variable is not set the `#[rustfmt_only_ci_test]` will be replaced with an `#[ignore]`.
85 lines
2.5 KiB
Rust
85 lines
2.5 KiB
Rust
//! This crate provides a derive macro for `ConfigType`.
|
|
|
|
#![recursion_limit = "256"]
|
|
|
|
mod attrs;
|
|
mod config_type;
|
|
mod item_enum;
|
|
mod item_struct;
|
|
mod utils;
|
|
|
|
use std::str::FromStr;
|
|
|
|
use proc_macro::TokenStream;
|
|
use syn::parse_macro_input;
|
|
|
|
#[proc_macro_attribute]
|
|
pub fn config_type(_args: TokenStream, input: TokenStream) -> TokenStream {
|
|
let input = parse_macro_input!(input as syn::Item);
|
|
let output = config_type::define_config_type(&input);
|
|
|
|
#[cfg(feature = "debug-with-rustfmt")]
|
|
{
|
|
utils::debug_with_rustfmt(&output);
|
|
}
|
|
|
|
TokenStream::from(output)
|
|
}
|
|
|
|
/// Used to conditionally output the TokenStream for tests that need to be run on nightly only.
|
|
///
|
|
/// ```rust
|
|
/// # use rustfmt_config_proc_macro::nightly_only_test;
|
|
///
|
|
/// #[nightly_only_test]
|
|
/// #[test]
|
|
/// fn test_needs_nightly_rustfmt() {
|
|
/// assert!(true);
|
|
/// }
|
|
/// ```
|
|
#[proc_macro_attribute]
|
|
pub fn nightly_only_test(_args: TokenStream, input: TokenStream) -> TokenStream {
|
|
// if CFG_RELEASE_CHANNEL is not set we default to nightly, hence why the default is true
|
|
if option_env!("CFG_RELEASE_CHANNEL").map_or(true, |c| c == "nightly" || c == "dev") {
|
|
input
|
|
} else {
|
|
// output an empty token stream if CFG_RELEASE_CHANNEL is not set to "nightly" or "dev"
|
|
TokenStream::from_str("").unwrap()
|
|
}
|
|
}
|
|
|
|
/// Used to conditionally output the TokenStream for tests that need to be run on stable only.
|
|
///
|
|
/// ```rust
|
|
/// # use rustfmt_config_proc_macro::stable_only_test;
|
|
///
|
|
/// #[stable_only_test]
|
|
/// #[test]
|
|
/// fn test_needs_stable_rustfmt() {
|
|
/// assert!(true);
|
|
/// }
|
|
/// ```
|
|
#[proc_macro_attribute]
|
|
pub fn stable_only_test(_args: TokenStream, input: TokenStream) -> TokenStream {
|
|
// if CFG_RELEASE_CHANNEL is not set we default to nightly, hence why the default is false
|
|
if option_env!("CFG_RELEASE_CHANNEL").map_or(false, |c| c == "stable") {
|
|
input
|
|
} else {
|
|
// output an empty token stream if CFG_RELEASE_CHANNEL is not set or is not 'stable'
|
|
TokenStream::from_str("").unwrap()
|
|
}
|
|
}
|
|
|
|
/// Used to conditionally output the TokenStream for tests that should be run as part of rustfmts
|
|
/// test suite, but should be ignored when running in the rust-lang/rust test suite.
|
|
#[proc_macro_attribute]
|
|
pub fn rustfmt_only_ci_test(_args: TokenStream, input: TokenStream) -> TokenStream {
|
|
if option_env!("RUSTFMT_CI").is_some() {
|
|
input
|
|
} else {
|
|
let mut token_stream = TokenStream::from_str("#[ignore]").unwrap();
|
|
token_stream.extend(input);
|
|
token_stream
|
|
}
|
|
}
|