Formatting proposal: Ensure empty line between method definitions #461
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.
We've been using SyntaxTree extensively for formatting in a number of our apps at work, and I recently came across something I was a bit surprised wasn't already part of the formatting rules: ensuring there's a blank line between each method definition.
Before this change, the following code would be unchanged by SyntaxTree:
After, it will be formatted like so:
I think this is a fairly uncontroversial formatting opinion (though I've certainly misjudged these before 😄). It lines up with the RuboCop default for
Layout/EmptyLineBetweenDefs
, which of course is disable when using the SyntaxTree RuboCop config. I stopped short of doing the same for classes and modules as method definitions seemed the most common to have in succession.I took a swing at implementing the change, but I'm not terribly confident that this is exactly the right approach. I have run this against a few of our code bases and haven't seen any unintended changes.
Is this something you'd consider tweaking in SyntaxTree? If so, is there anything I can do differently in the implementation to help it fit in with the rest of the project?