Fix auto indent after end #2086
Merged
Conversation
This file contains 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
This commit fixes the auto indentation after the `end` keyword when the
body is more complex, such as when there are nested blocks.
Previously the following code:
```ruby
if foo
if bar
baz
end
end
```
…would have been indented like this:
```rb
if foo
if bar
baz
end
end
```
Now it will be correctly indented like this:
```rb
if foo
if bar
baz
end
end
```
It does so by indenting each line in the node location, instead of just
the first one.
This commit ensures auto-indentation after an `end` keyword does not add
extra indentation if the body is already indented.
Previously the following code:
```rb
if foo
bar
end
```
…would have been indented like this:
```rb
if foo
bar
end
```
Now it will be correctly indented like this:
```rb
if foo
bar
end
```
It does so by finding the correct current indentation level, and
skipping indentation if it already matches.
vinistock
added
bugfix
andyw8
pushed a commit
that referenced
this pull request
May 29, 2024
* Fix complex body indentation after end keyword
This commit fixes the auto indentation after the `end` keyword when the
body is more complex, such as when there are nested blocks.
Previously the following code:
```ruby
if foo
if bar
baz
end
end
```
…would have been indented like this:
```rb
if foo
if bar
baz
end
end
```
Now it will be correctly indented like this:
```rb
if foo
if bar
baz
end
end
```
It does so by indenting each line in the node location, instead of just
the first one.
* Fix extra indentation after end keyword
This commit ensures auto-indentation after an `end` keyword does not add
extra indentation if the body is already indented.
Previously the following code:
```rb
if foo
bar
end
```
…would have been indented like this:
```rb
if foo
bar
end
```
Now it will be correctly indented like this:
```rb
if foo
bar
end
```
It does so by finding the correct current indentation level, and
skipping indentation if it already matches.
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.
Motivation
I noticed a few small issues since enabling on-type formatting recently. In particular, it adds incorrect indentation in some cases after typing the
endkeyword. It's not a big deal really because the code will be auto-formatted when saving the file, but I thought I would try to fix the easier ones to make the editing experience a bit nicer.Complex body indentation
Existing indentation
Implementation
Automated Tests
I've added a test case for each fix to
OnTypeFormattingTest.Manual Tests
Then add the final
d.Then add the final
d.