feat(eslint-plugin): add rule object-curly-spacing #1884
Closed
Conversation
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
|
Thanks for the PR, @Kiikurage! typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community. The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately. Thanks again! 🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day. |
Codecov Report
@@ Coverage Diff @@
## master #1884 +/- ##
==========================================
+ Coverage 94.49% 94.53% +0.03%
==========================================
Files 162 163 +1
Lines 7471 7521 +50
Branches 2139 2154 +15
==========================================
+ Hits 7060 7110 +50
Misses 178 178
Partials 233 233
|
|
@bradzacher Wat would need to happen before this PR can be reviewed (besides perhaps @Kiikurage rebasing the branch on master because of the merge conflict)? |
bradzacher
requested changes
May 17, 2020
| ## Rule Details | ||
|
|
||
| This rule extends the base [`eslint/object-curly-spacing`](https://eslint.org/docs/rules/object-curly-spacing) rule. | ||
| It supports all options and features of the base rule. |
There was a problem hiding this comment.
Suggested change
| It supports all options and features of the base rule. | |
| It adds support for TypeScript's object types |
Comment on lines
+29
to
+34
| messages: { | ||
| requireSpaceBefore: "A space is required before '{{token}}'.", | ||
| requireSpaceAfter: "A space is required after '{{token}}'.", | ||
| unexpectedSpaceBefore: "There should be no space before '{{token}}'.", | ||
| unexpectedSpaceAfter: "There should be no space after '{{token}}'.", | ||
| }, |
There was a problem hiding this comment.
No need to redeclare if you're not changing the messages.
Suggested change
| messages: { | |
| requireSpaceBefore: "A space is required before '{{token}}'.", | |
| requireSpaceAfter: "A space is required after '{{token}}'.", | |
| unexpectedSpaceBefore: "There should be no space before '{{token}}'.", | |
| unexpectedSpaceAfter: "There should be no space after '{{token}}'.", | |
| }, | |
| messages: baseRule.messages, |
Comment on lines
+40
to
+41
| const spaced = context.options[0] === 'always', | ||
| sourceCode = context.getSourceCode(); |
There was a problem hiding this comment.
nit
Suggested change
| const spaced = context.options[0] === 'always', | |
| sourceCode = context.getSourceCode(); | |
| const spaced = context.options[0] === 'always'; | |
| const sourceCode = context.getSourceCode(); |
Comment on lines
+47
to
+48
| * @param {Object} option The option to exclude. | ||
| * @returns {boolean} Whether or not the property is excluded. |
There was a problem hiding this comment.
nitpick
Suggested change
| * @param {Object} option The option to exclude. | |
| * @returns {boolean} Whether or not the property is excluded. | |
| * @param option The option to exclude. | |
| * @returns Whether or not the property is excluded. |
Comment on lines
+262
to
+265
| const first = sourceCode.getFirstToken(node)!, | ||
| last = getClosingBraceOfObject(node)!, | ||
| second = sourceCode.getTokenAfter(first, { includeComments: true })!, | ||
| penultimate = sourceCode.getTokenBefore(last, { |
There was a problem hiding this comment.
nit
Suggested change
| const first = sourceCode.getFirstToken(node)!, | |
| last = getClosingBraceOfObject(node)!, | |
| second = sourceCode.getTokenAfter(first, { includeComments: true })!, | |
| penultimate = sourceCode.getTokenBefore(last, { | |
| const first = sourceCode.getFirstToken(node)!; | |
| const last = getClosingBraceOfObject(node)!; | |
| const second = sourceCode.getTokenAfter(first, { includeComments: true })!; | |
| const penultimate = sourceCode.getTokenBefore(last, { |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
added new extended rule
object-curly-spacingFixes #1784