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

Don't wrap comments that are part of a table #5475

Merged
merged 4 commits into from
Jan 29, 2023
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
15 changes: 14 additions & 1 deletion src/comment.rs
Original file line number Diff line number Diff line change
Expand Up @@ -804,7 +804,8 @@ impl<'a> CommentRewrite<'a> {
let should_wrap_comment = self.fmt.config.wrap_comments()
&& !is_markdown_header_doc_comment
&& unicode_str_width(line) > self.fmt.shape.width
&& !has_url(line);
&& !has_url(line)
&& !is_table_item(line);

if should_wrap_comment {
match rewrite_string(line, &self.fmt, self.max_width) {
Expand Down Expand Up @@ -939,6 +940,18 @@ fn has_url(s: &str) -> bool {
|| REFERENCE_LINK_URL.is_match(s)
}

/// Returns true if the given string may be part of a Markdown table.
fn is_table_item(mut s: &str) -> bool {
// This function may return false positive, but should get its job done in most cases (i.e.
// markdown tables with two column delimiters).
s = s.trim_start();
return s.starts_with('|')
&& match s.rfind('|') {
Some(0) | None => false,
_ => true,
};
}

/// Given the span, rewrite the missing comment inside it if available.
/// Note that the given span must only include comments (or leading/trailing whitespaces).
pub(crate) fn rewrite_missing_comment(
Expand Down
15 changes: 15 additions & 0 deletions tests/target/issue-4210-disabled.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
// rustfmt-wrap_comments: false

/// Table that is > 80 symbols:
///
/// | table | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
/// |-------|-----------------------------------------------------------------------------|
/// | val | x |
pub struct Item;

/// Table value that is > 80 symbols:
///
/// | table | heading
/// |----------|-----------------------------------------------------------------------------
/// | long val | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
pub struct Item2;
15 changes: 15 additions & 0 deletions tests/target/issue-4210.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
// rustfmt-wrap_comments: true

/// Table that is > 80 symbols:
///
/// | table | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
/// |-------|-----------------------------------------------------------------------------|
/// | val | x |
pub struct Item;

/// Table value that is > 80 symbols:
///
/// | table | heading
/// |----------|-----------------------------------------------------------------------------
/// | long val | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
pub struct Item2;