Require newlines between multiline blocks and expressions#197
Merged
Conversation
Member
Author
|
Extension diff after applying this rule: Some relevant statistics:
|
Member
Author
|
The picture is similar for mobile, with 107 out of 600 |
Gudahtt
approved these changes
Aug 6, 2021
Member
Gudahtt
left a comment
There was a problem hiding this comment.
LGTM! This seems nice. Breaking change, but that's OK.
Gudahtt
added a commit
that referenced
this pull request
Dec 12, 2022
This effectively reverts #197. This rule is being removed because we have found that it forces us to introduce newlines in places where they obstruct readability rather than helping it. When grouping statements, it is often useful to "chunk" related lines together by using a newline before and after the chunk, to denote that each of the statements are related in some way. This is often done in unit tests for example, when the "arrange", "act", "assert" grouping style is used. This rule was forcing us to break up chunks.
Gudahtt
added a commit
that referenced
this pull request
Dec 12, 2022
This effectively reverts #197. This rule is being removed because we have found that it forces us to introduce newlines in places where they obstruct readability rather than helping it. When grouping statements, it is often useful to "chunk" related lines together by using a newline before and after the chunk, to denote that each of the statements are related in some way. This is often done in unit tests for example, when the "arrange", "act", "assert" grouping style is used. This rule was forcing us to break up chunks.
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
2 participants
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.
This PR adds another condition where we apply the
padding-line-between-statements, namely between multiline blocks and expressions. Whenever we forget to manually add newlines between multiline blocks and expressions, our files become significantly less navigable for those of us that use vim. It also makes our files cramped and harder to read, especially tests.We already tend to do this in practice, so this is best viewed as enforcing an existing, informal standard.
By way of example,
multiline-block-likeoption results in the following change:While the
multiline-expressionoption results in the following: