Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork2.8k
feat(eslint-plugin): addkey-spacing rule extension for interface & type declarations#6211
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
Thanks for the PR,@coyotte508! 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 onhttps://opencollective.com/typescript-eslint. |
nx-cloudbot commentedDec 14, 2022 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
netlifybot commentedDec 14, 2022 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
✅ Deploy Preview fortypescript-eslint ready!
To edit notification comments on pull requests, go to yourNetlify site settings. |
JoshuaKGoldberg commentedDec 14, 2022
Yup! 😁 |
key-spacing for interface & type declarationskey-spacing for interface & type declarationscoyotte508 commentedDec 15, 2022 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
The base implementation is done - Key alignment is done for interface / types / classes properties & index signatures. I still need to do the autofixer & the docs. And probably test more. |
It defaults to 'colon' in this case
coyotte508 commentedJan 24, 2023
Justa few lines to handle unicode characters + a module that can be replaced by No if/else in added in the rule's logic :)
Can't say I disagree, if it was up to me I'd use prettier and call it a day 🤫 Still, this rule grows on you 🤷 I couldn't really address the |
Uh oh!
There was an error while loading.Please reload this page.
JoshuaKGoldberg commentedJan 24, 2023
Tangent: I miss working in a review tool that differentiated betweenmark as resolved (code author's responsibility) andclose (reviewer's responsibility). Alas. +1 to this being a not-clear thing on GitHub! |
JoshuaKGoldberg left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Looks great, thanks!
I do want to poke@bradzacher to make sure I'm not missing some dependency shenanigan withgrapheme-splitter (same as#5704). But otherwise looks wonderful, thanks!
Uh oh!
There was an error while loading.Please reload this page.
JoshuaKGoldberg left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
key-spacing for interface & type declarationskey-spacing rule extension for interface & type declarations| "grapheme-splitter":"^1.0.4", | ||
| "ignore":"^5.2.0", | ||
| "grapheme-splitter":"^1.0.4", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
looks like a bad merge - added the entry twice!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Eek.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
This PR contains the following updates:| Package | Type | Update | Change ||---|---|---|---|| [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.48.2` -> `5.50.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2feslint-plugin/5.48.2/5.50.0) || [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.48.2` -> `5.50.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2fparser/5.48.2/5.50.0) |---### Release Notes<details><summary>typescript-eslint/typescript-eslint (@​typescript-eslint/eslint-plugin)</summary>### [`v5.50.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#​5500-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5490v5500-2023-01-31)[Compare Source](typescript-eslint/typescript-eslint@v5.49.0...v5.50.0)##### Bug Fixes- **eslint-plugin:** \[ban-ts-comment] counts graphemes instead of `String.prototype.length` ([#​5704](typescript-eslint/typescript-eslint#5704)) ([09d57ce](typescript-eslint/typescript-eslint@09d57ce))- **eslint-plugin:** \[prefer-optional-chain] fix `ThisExpression` and `PrivateIdentifier` errors ([#​6028](typescript-eslint/typescript-eslint#6028)) ([85e783c](typescript-eslint/typescript-eslint@85e783c))- **eslint-plugin:** \[prefer-optional-chain] fixer produces wrong logic ([#​5919](typescript-eslint/typescript-eslint#5919)) ([b0f6c8e](typescript-eslint/typescript-eslint@b0f6c8e)), closes [#​1438](typescript-eslint/typescript-eslint#1438)##### Features- **eslint-plugin:** add `key-spacing` rule extension for interface & type declarations ([#​6211](typescript-eslint/typescript-eslint#6211)) ([67706e7](typescript-eslint/typescript-eslint@67706e7))### [`v5.49.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#​5490-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5482v5490-2023-01-23)[Compare Source](typescript-eslint/typescript-eslint@v5.48.2...v5.49.0)##### Features- **eslint-plugin:** \[naming-convention] add support for `#private` modifier on class members ([#​6259](typescript-eslint/typescript-eslint#6259)) ([c8a6d80](typescript-eslint/typescript-eslint@c8a6d80))#### [5.48.2](typescript-eslint/typescript-eslint@v5.48.1...v5.48.2) (2023-01-16)**Note:** Version bump only for package [@​typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/eslint-plugin)#### [5.48.1](typescript-eslint/typescript-eslint@v5.48.0...v5.48.1) (2023-01-09)**Note:** Version bump only for package [@​typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/eslint-plugin)</details><details><summary>typescript-eslint/typescript-eslint (@​typescript-eslint/parser)</summary>### [`v5.50.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#​5500-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5490v5500-2023-01-31)[Compare Source](typescript-eslint/typescript-eslint@v5.49.0...v5.50.0)**Note:** Version bump only for package [@​typescript-eslint/parser](https://github.com/typescript-eslint/parser)### [`v5.49.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#​5490-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5482v5490-2023-01-23)[Compare Source](typescript-eslint/typescript-eslint@v5.48.2...v5.49.0)**Note:** Version bump only for package [@​typescript-eslint/parser](https://github.com/typescript-eslint/parser)#### [5.48.2](typescript-eslint/typescript-eslint@v5.48.1...v5.48.2) (2023-01-16)**Note:** Version bump only for package [@​typescript-eslint/parser](https://github.com/typescript-eslint/parser)#### [5.48.1](typescript-eslint/typescript-eslint@v5.48.0...v5.48.1) (2023-01-09)**Note:** Version bump only for package [@​typescript-eslint/parser](https://github.com/typescript-eslint/parser)</details>---### Configuration📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.🔕 **Ignore**: Close this PR and you won't be reminded about these updates again.--- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box---This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC4xMTQuMSIsInVwZGF0ZWRJblZlciI6IjM0LjExOS4yIn0=-->Co-authored-by: cabr2-bot <cabr2.help@gmail.com>Reviewed-on:https://codeberg.org/Calciumdibromid/CaBr2/pulls/1757Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org>Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
Uh oh!
There was an error while loading.Please reload this page.
PR Checklist
Overview
Make
key-spacingwork with interfaces & type declarations.🚧Work in progress 🚧.Happy to take any and all feedback & help.
Do I need to support all options & sub-options from the base rule? 😓edit by@JoshuaKGoldberg: summarizing discussion, yes 😄References
eslint rule:https://eslint.org/docs/latest/rules/key-spacing
eslint rule source:https://github.com/eslint/eslint/blob/main/lib/rules/key-spacing.js#L491
Todo