Skip to content

Commit

Permalink
Move rustfmt changes out
Browse files Browse the repository at this point in the history
  • Loading branch information
GKFX committed Apr 28, 2024
1 parent a0a8442 commit 8aa3c59
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 20 deletions.
1 change: 1 addition & 0 deletions Cargo.lock
Original file line number Diff line number Diff line change
Expand Up @@ -4884,6 +4884,7 @@ dependencies = [
"getopts",
"ignore",
"itertools 0.11.0",
"lazy_static",
"regex",
"rustfmt-config_proc_macro",
"serde",
Expand Down
1 change: 1 addition & 0 deletions src/tools/rustfmt/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ dirs = "4.0"
getopts = "0.2"
ignore = "0.4"
itertools = "0.11"
lazy_static = "1.4"
regex = "1.7"
serde = { version = "1.0.160", features = ["derive"] }
serde_json = "1.0"
Expand Down
20 changes: 14 additions & 6 deletions src/tools/rustfmt/src/comment.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
use std::{borrow::Cow, iter};

use itertools::{multipeek, MultiPeek};
use lazy_static::lazy_static;
use regex::Regex;
use rustc_span::Span;

use crate::config::Config;
Expand All @@ -15,6 +17,17 @@ use crate::utils::{
};
use crate::{ErrorKind, FormattingError};

lazy_static! {
/// A regex matching reference doc links.
///
/// ```markdown
/// /// An [example].
/// ///
/// /// [example]: this::is::a::link
/// ```
static ref REFERENCE_LINK_URL: Regex = Regex::new(r"^\[.+\]\s?:").unwrap();
}

fn is_custom_comment(comment: &str) -> bool {
if !comment.starts_with("//") {
false
Expand Down Expand Up @@ -967,16 +980,11 @@ fn trim_custom_comment_prefix(s: &str) -> String {
/// Returns `true` if the given string MAY include URLs or alike.
fn has_url(s: &str) -> bool {
// This function may return false positive, but should get its job done in most cases.
// The regex is indended to capture text such as the below.
//
// /// An [example].
// ///
// /// [example]: this::is::a::link
s.contains("https://")
|| s.contains("http://")
|| s.contains("ftp://")
|| s.contains("file://")
|| static_regex!(r"^\[.+\]\s?:").is_match(s)
|| REFERENCE_LINK_URL.is_match(s)
}

/// Returns true if the given string may be part of a Markdown table.
Expand Down
10 changes: 3 additions & 7 deletions src/tools/rustfmt/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
#![allow(clippy::match_like_matches_macro)]
#![allow(unreachable_pub)]

#[cfg(test)]
#[macro_use]
extern crate lazy_static;
#[macro_use]
extern crate tracing;

Expand Down Expand Up @@ -59,13 +62,6 @@ pub use crate::rustfmt_diff::{ModifiedChunk, ModifiedLines};
#[macro_use]
mod utils;

macro_rules! static_regex {
($re:literal) => {{
static RE: ::std::sync::OnceLock<::regex::Regex> = ::std::sync::OnceLock::new();
RE.get_or_init(|| ::regex::Regex::new($re).unwrap())
}};
}

mod attr;
mod chains;
mod closures;
Expand Down
22 changes: 15 additions & 7 deletions src/tools/rustfmt/src/test/configuration_snippet.rs
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,19 @@ impl ConfigurationSection {
fn get_section<I: Iterator<Item = String>>(
file: &mut Enumerate<I>,
) -> Option<ConfigurationSection> {
lazy_static! {
static ref CONFIG_NAME_REGEX: regex::Regex =
regex::Regex::new(r"^## `([^`]+)`").expect("failed creating configuration pattern");
// Configuration values, which will be passed to `from_str`:
//
// - must be prefixed with `####`
// - must be wrapped in backticks
// - may by wrapped in double quotes (which will be stripped)
static ref CONFIG_VALUE_REGEX: regex::Regex =
regex::Regex::new(r#"^#### `"?([^`]+?)"?`"#)
.expect("failed creating configuration value pattern");
}

loop {
match file.next() {
Some((i, line)) => {
Expand All @@ -40,14 +53,9 @@ impl ConfigurationSection {
let start_line = (i + 2) as u32;

return Some(ConfigurationSection::CodeBlock((block, start_line)));
} else if let Some(c) = static_regex!(r"^## `([^`]+)`").captures(&line) {
} else if let Some(c) = CONFIG_NAME_REGEX.captures(&line) {
return Some(ConfigurationSection::ConfigName(String::from(&c[1])));
} else if let Some(c) = static_regex!(r#"^#### `"?([^`]+?)"?`"#).captures(&line) {
// Configuration values, which will be passed to `from_str`
//
// - must be prefixed with `####`
// - must be wrapped in backticks
// - may by wrapped in double quotes (which will be stripped)
} else if let Some(c) = CONFIG_VALUE_REGEX.captures(&line) {
return Some(ConfigurationSection::ConfigValue(String::from(&c[1])));
}
}
Expand Down

0 comments on commit 8aa3c59

Please sign in to comment.