feat: add new rule enforce-line-break #484
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
added 3 commits
June 25, 2021 22:10
…bove type declaration is on the 1st line, update tests
Brianzchen
reviewed
Jun 28, 2021
src/rules/enforceLineBreak.js
Outdated
| fix (fixer) { | ||
| return fixer.insertTextBeforeRange(node.leadingComments[0].range, '\n'); | ||
| }, | ||
| message: 'Please enter a line above type declaration', |
There was a problem hiding this comment.
I think the error messages general have the tone of New line required above type declaration. Should we change to like that?
src/rules/enforceLineBreak.js
Outdated
| fix (fixer) { | ||
| return fixer.insertTextBefore(node, '\n'); | ||
| }, | ||
| message: 'Please enter a line above type declaration', |
There was a problem hiding this comment.
Should the message itself be a func that can be reused for both above and below?
const breakLineMessage = (direction) => `Please enter a line ${direction} type declaration`;
| return; | ||
| } | ||
|
|
||
| if (node.loc.start.line !== 1) { |
There was a problem hiding this comment.
Just curious what does this do?
There was a problem hiding this comment.
This is so you won't get the error 'New line required above type declaration` if the type declaration happens to be on the first line.
|
🎉 This PR is included in version 5.8.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
New rule to enforce line breaks before and after type declarations.
Closes #476
@gajus