mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-09-26 11:59:35 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Improve some comments in normalize_comment (#7688)

Browse source
This commit is contained in:
Charlie Marsh 2023-09-27 23:08:25 -04:00 • committed by GitHub
parent a6d79c03b3
commit 8028de8956
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

21
crates/ruff_python_formatter/src/comments/format.rs
View file

@ -450,12 +450,15 @@ impl Format<PyFormatContext<'_>> for FormatNormalizedComment<'_> {
}
}
/// A helper for normalizing comments efficiently.
/// A helper for normalizing comments by:
/// * Trimming any trailing whitespace.
/// * Adding a leading space after the `#`, if necessary.
///
/// * Return as fast as possible without making unnecessary allocations.
/// * Trim any trailing whitespace.
/// * Normalize for a leading '# '.
/// * Retain non-breaking spaces for 'type:' pragmas by leading with '# \u{A0}'.
/// For example:
/// * `#comment` is normalized to `# comment`.
/// * `# comment ` is normalized to `# comment`.
/// * `# comment` is left as-is.
/// * `#!comment` is left as-is.
fn normalize_comment<'a>(
comment: &'a SourceComment,
source: SourceCode<'a>,
@ -471,16 +474,16 @@ fn normalize_comment<'a>(
return Ok(Cow::Borrowed("#"));
}
// Fast path for correctly formatted comments:
// * Start with a `# '.
// * Have no trailing whitespace.
// Fast path for correctly formatted comments: if the comment starts with a space, or any
// of the allowed characters, then it's included verbatim (apart for trimming any trailing
// whitespace).
if content.starts_with([' ', '!', ':', '#', '\'']) {
return Ok(Cow::Borrowed(trimmed));
}
// Otherwise, we need to normalize the comment by adding a space after the `#`.
if content.starts_with('\u{A0}') {
let trimmed = content.trim_start_matches('\u{A0}');
if trimmed.trim_start().starts_with("type:") {
// Black adds a space before the non-breaking space if part of a type pragma.
Ok(Cow::Owned(std::format!("# {content}")))