Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: do not wrap reference-style doc links #5096

Merged
merged 1 commit into from
Nov 23, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion src/comment.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
use std::{self, 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 @@ -842,7 +855,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.
s.contains("https://") || s.contains("http://") || s.contains("ftp://") || s.contains("file://")
s.contains("https://")
|| s.contains("http://")
|| s.contains("ftp://")
|| s.contains("file://")
|| REFERENCE_LINK_URL.is_match(s)
}

/// Given the span, rewrite the missing comment inside it if available.
Expand Down
27 changes: 27 additions & 0 deletions tests/target/issue-5095.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
// rustfmt-wrap_comments: true

pub mod a_long_name {
pub mod b_long_name {
pub mod c_long_name {
pub mod d_long_name {
pub mod e_long_name {
pub struct Bananas;
impl Bananas {
pub fn fantastic() {}
}

pub mod f_long_name {
pub struct Apples;
}
}
}
}
}
}

/// Check out [my other struct] ([`Bananas`]) and [the method it has].
///
/// [my other struct]: a_long_name::b_long_name::c_long_name::d_long_name::e_long_name::f_long_name::Apples
/// [`Bananas`]: a_long_name::b_long_name::c_long_name::d_long_name::e_long_name::Bananas::fantastic()
/// [the method it has]: a_long_name::b_long_name::c_long_name::d_long_name::e_long_name::Bananas::fantastic()
pub struct A;