editor: Fix splitting brackets inside line comments - #59260
Merged
Conversation
ChristopherBiscardi
enabled auto-merge
June 15, 2026 03:51
This was referenced Jun 18, 2026
Closed
This was referenced Jul 1, 2026
This was referenced Jul 10, 2026
jolutz
pushed a commit
to jolutz/zed
that referenced
this pull request
Aug 8, 2026
…9260) # Objective Closes zed-industries#59229 When adding a newline, Zed has a bit of intelligence to do more work than just inserting a `\n`. For comment lines, it simply extends the comment: ```rust Before // This is a comment, ˇThis is another comment After // This is a comment, // ˇThis is another comment ``` And when the cursor is inside bracket pairs, Zed inserts another newline to move the closing bracket to a new line: ```rust Before fn main() {ˇ} After fn main() { ˇ } ``` However, when we have a comment line with the cursor inside a bracket pair, both mechanisms apply, resulting in an unintended state where the closing bracket is kicked out of the comment: ```rust Before // {ˇ} After // { // ˇ } ``` We definitely do not need the bracket extension rule when we are adding a newline inside comments. We want comment lines inside brackets to be split like this: ```rust // { // ˇ} ``` ## Solution - Disable Bracket Extra Newline in Comments: When a line comment delimiter is detected, we override the default `newline_config` to set `extra_line_additional_indent` to `None` . - Avoid Rule Conflicts (Short-circuiting): The three newline customization helpers (line comment, block comment, and list item) are mutually exclusive. I refactored their execution from a sequential list into an `if let Some ... else if let Some` branch. This prevents subsequent rules from having side effects on `newline_config` when a match has already occurred. ## Testing A new test named `test_newline_comments_with_brackets` is introduced in `crates/editor/src/editor_tests.rs`, All tests in the `editor` crate were verified using `cargo test -p editor` . ## Self-Review Checklist: - [x] I've reviewed my own diff for quality, security, and reliability - [x] Unsafe blocks (if any) have justifying comments - [x] The content adheres to Zed's UI standards ([UX/UI](https://github.com/zed-industries/zed/blob/main/CONTRIBUTING.md#uiux-checklist) and [icon](https://github.com/zed-industries/zed/blob/main/crates/icons/README.md) guidelines) - [x] Tests cover the new/changed behavior - [x] Performance impact has been considered and is acceptable --- Release Notes: - Fixed an issue where splitting brackets inside line comments inserted an extra line and broke the comment formatting
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Objective
Closes #59229
When adding a newline, Zed has a bit of intelligence to do more work than just inserting a
\n. For comment lines, it simply extends the comment:And when the cursor is inside bracket pairs, Zed inserts another newline to move the closing bracket to a new line:
However, when we have a comment line with the cursor inside a bracket pair, both mechanisms apply, resulting in an unintended state where the closing bracket is kicked out of the comment:
We definitely do not need the bracket extension rule when we are adding a newline inside comments. We want comment lines inside brackets to be split like this:
Solution
newline_configto setextra_line_additional_indenttoNone.if let Some ... else if let Somebranch. This prevents subsequent rules from having side effects onnewline_configwhen a match has already occurred.Testing
A new test named
test_newline_comments_with_bracketsis introduced incrates/editor/src/editor_tests.rs, All tests in theeditorcrate were verified usingcargo test -p editor.Self-Review Checklist:
Release Notes: