Yehowshua/ZIm
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

editor: Fix "Toggle comments" not respecting multiple line_comments in language config (#10126)

Browse source 
This does not try to heuristically pick a comment style based on
surroundings anyhow. It does improve our story around uncommenting
though.

Fixes #10113.

Release Notes:

- Fixed "Toggle comment" action not working in presence of non-default
line comments such as doc comments in Rust
([#10113](https://github.com/zed-industries/zed/issues/10113)).
This commit is contained in:
Piotr Osiewicz 2024-04-03 17:34:59 +02:00 • committed by GitHub
parent 57a1b9b2cd
commit b118b76272
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 41 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

55
crates/editor/src/editor.rs
View file

@ -7092,14 +7092,27 @@ impl Editor {
} }
// If the language has line comments, toggle those. // If the language has line comments, toggle those.
if let Some(full_comment_prefix) = language if let Some(full_comment_prefixes) = language
.line_comment_prefixes() .line_comment_prefixes()
.and_then(|prefixes| prefixes.first()) .filter(|prefixes| !prefixes.is_empty())
{ {
// Split the comment prefix's trailing whitespace into a separate string, // Split the comment prefix's trailing whitespace into a separate string,
// as that portion won't be used for detecting if a line is a comment. // as that portion won't be used for detecting if a line is a comment.
let comment_prefix = full_comment_prefix.trim_end_matches(' '); struct Comment {
let comment_prefix_whitespace = &full_comment_prefix[comment_prefix.len()..]; full_prefix: Arc<str>,
trimmed_prefix_len: usize,
}
let prefixes: SmallVec<[Comment; 4]> = full_comment_prefixes
.iter()
.map(|full_prefix| {
let trimmed_prefix_len = full_prefix.trim_end_matches(' ').len();
Comment {
trimmed_prefix_len,
full_prefix: full_prefix.clone(),
}
})
.collect();
let mut all_selection_lines_are_comments = true; let mut all_selection_lines_are_comments = true;
for row in start_row..=end_row { for row in start_row..=end_row {
@ -7107,16 +7120,28 @@ impl Editor {
continue; continue;
} }
let prefix_range = comment_prefix_range( let Some((prefix, prefix_range)) = prefixes
snapshot.deref(), .iter()
row, .map(|prefix| {
comment_prefix, (
comment_prefix_whitespace, prefix,
); comment_prefix_range(
snapshot.deref(),
row,
&prefix.full_prefix[..prefix.trimmed_prefix_len],
&prefix.full_prefix[prefix.trimmed_prefix_len..],
),
)
})
.max_by_key(|(_, range)| range.end.column - range.start.column)
else {
// There has to be at least one prefix.
break;
};
if prefix_range.is_empty() { if prefix_range.is_empty() {
all_selection_lines_are_comments = false; all_selection_lines_are_comments = false;
} }
selection_edit_ranges.push(prefix_range); selection_edit_ranges.push((prefix_range, prefix.full_prefix.clone()));
} }
if all_selection_lines_are_comments { if all_selection_lines_are_comments {
@ -7124,17 +7149,17 @@ impl Editor {
selection_edit_ranges selection_edit_ranges
.iter() .iter()
.cloned() .cloned()
.map(|range| (range, empty_str.clone())), .map(|(range, _)| (range, empty_str.clone())),
); );
} else { } else {
let min_column = selection_edit_ranges let min_column = selection_edit_ranges
.iter() .iter()
.map(|r| r.start.column) .map(|(range, _)| range.start.column)
.min() .min()
.unwrap_or(0); .unwrap_or(0);
edits.extend(selection_edit_ranges.iter().map(|range| { edits.extend(selection_edit_ranges.iter().map(|(range, prefix)| {
let position = Point::new(range.start.row, min_column); let position = Point::new(range.start.row, min_column);
(position..position, full_comment_prefix.clone()) (position..position, prefix.clone())
})); }));
} }
} else if let Some((full_comment_prefix, comment_suffix)) = } else if let Some((full_comment_prefix, comment_suffix)) =

2
crates/languages/src/rust/config.toml
View file

@ -1,7 +1,7 @@
name = "Rust" name = "Rust"
grammar = "rust" grammar = "rust"
path_suffixes = ["rs"] path_suffixes = ["rs"]
line_comments = ["// ", "/// ", "//! "] line_comments = [ "/// ", "//! ", "// "]
autoclose_before = ";:.,=}])>" autoclose_before = ";:.,=}])>"
brackets = [ brackets = [
{ start = "{", end = "}", close = true, newline = true }, { start = "{", end = "}", close = true, newline = true },