Skip to content
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 our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(eslint-plugin): add key-spacing rule extension for interface & type declarations #6211

Merged
merged 43 commits into from Jan 24, 2023

Conversation

coyotte508
Copy link
Contributor

@coyotte508 coyotte508 commented Dec 14, 2022

PR Checklist

Overview

Make key-spacing work 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

  • add more tests
  • add autofix
  • add doc

@typescript-eslint
Copy link
Contributor

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 on https://opencollective.com/typescript-eslint.

@nx-cloud
Copy link

nx-cloud bot commented Dec 14, 2022

鈽侊笍 Nx Cloud Report

CI is running/has finished running commands for commit 0184de9. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

馃搨 See all runs for this branch


Successfully ran 47 targets

Sent with 馃拰 from NxCloud.

@netlify
Copy link

netlify bot commented Dec 14, 2022

Deploy Preview for typescript-eslint ready!

Name Link
馃敤 Latest commit 0184de9
馃攳 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/63d064362ba3200008ff3d39
馃槑 Deploy Preview https://deploy-preview-6211--typescript-eslint.netlify.app
馃摫 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@JoshuaKGoldberg
Copy link
Member

Do I need to support all options & sub-options from the base rule? 馃槗

Yup! 馃榿

@coyotte508 coyotte508 changed the title feat(eslint-plugin): key-spacing for interface & type declarations feat(eslint-plugin): support key-spacing for interface & type declarations Dec 14, 2022
@coyotte508
Copy link
Contributor Author

coyotte508 commented Dec 15, 2022

The base implementation is done - I had to hack around a bit for index signatures: { [x: number]: string}, I found no way to get the position of the ] other than to check the text value of the whole node.

Key alignment is done for interface / types / classes properties & index signatures.

I still need to do the autofixer & the docs. And probably test more.

@coyotte508 coyotte508 marked this pull request as ready for review December 15, 2022 11:51
@coyotte508
Copy link
Contributor Author

Mainly requesting changes here for more thorough testing of edge cases and different options. Hopefully they don't make the code too much more lots-of-different-cases-y?

Just a few lines to handle unicode characters + a module that can be replaced by Intl.Segmenter when Node 14 stops being supported.

No if/else in added in the rule's logic :)

I hope that the painstaking annoying edge cases you're working through in this PR have at least helped emphasize why we strongly recommend nobody use key-spacing or other formatting rules`. smile

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 MakeRequired comment, due to Typescript limitations I think. I marked the other comments as resolved, not sure it's the etiquette for this project or if the initial commenter should be the one to, feel free to reopen them in any case!

@coyotte508 coyotte508 marked this pull request as ready for review January 24, 2023 17:13
@JoshuaKGoldberg
Copy link
Member

not sure it's the etiquette for this project or if the initial commenter should be the one to

Tangent: I miss working in a review tool that differentiated between mark as resolved (code author's responsibility) and close (reviewer's responsibility). Alas. +1 to this being a not-clear thing on GitHub!

Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a 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 with grapheme-splitter (same as #5704). But otherwise looks wonderful, thanks!

@JoshuaKGoldberg JoshuaKGoldberg added 1 approval PR that a maintainer has LGTM'd - any maintainer can merge this when ready and removed awaiting response Issues waiting for a reply from the OP or another party labels Jan 24, 2023
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

@JoshuaKGoldberg JoshuaKGoldberg changed the title feat(eslint-plugin): support key-spacing for interface & type declarations feat(eslint-plugin): add key-spacing rule extension for interface & type declarations Jan 24, 2023
@JoshuaKGoldberg JoshuaKGoldberg merged commit 67706e7 into typescript-eslint:main Jan 24, 2023
40 of 42 checks passed
"grapheme-splitter": "^1.0.4",
"ignore": "^5.2.0",
"grapheme-splitter": "^1.0.4",
Copy link
Member

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!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Eek.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@coyotte508 coyotte508 deleted the key-spacing branch January 31, 2023 13:35
crapStone pushed a commit to Calciumdibromid/CaBr2 that referenced this pull request Feb 2, 2023
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 (@&#8203;typescript-eslint/eslint-plugin)</summary>

### [`v5.50.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#&#8203;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` ([#&#8203;5704](typescript-eslint/typescript-eslint#5704)) ([09d57ce](typescript-eslint/typescript-eslint@09d57ce))
-   **eslint-plugin:** \[prefer-optional-chain] fix `ThisExpression` and `PrivateIdentifier` errors ([#&#8203;6028](typescript-eslint/typescript-eslint#6028)) ([85e783c](typescript-eslint/typescript-eslint@85e783c))
-   **eslint-plugin:** \[prefer-optional-chain] fixer produces wrong logic ([#&#8203;5919](typescript-eslint/typescript-eslint#5919)) ([b0f6c8e](typescript-eslint/typescript-eslint@b0f6c8e)), closes [#&#8203;1438](typescript-eslint/typescript-eslint#1438)

##### Features

-   **eslint-plugin:** add `key-spacing` rule extension for interface & type declarations ([#&#8203;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#&#8203;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 ([#&#8203;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 [@&#8203;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 [@&#8203;typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/eslint-plugin)

</details>

<details>
<summary>typescript-eslint/typescript-eslint (@&#8203;typescript-eslint/parser)</summary>

### [`v5.50.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#&#8203;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 [@&#8203;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#&#8203;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 [@&#8203;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 [@&#8203;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 [@&#8203;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/1757
Reviewed-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>
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 8, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
1 approval PR that a maintainer has LGTM'd - any maintainer can merge this when ready
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[key-spacing] key-spacing of interfaces and other TS-specific key-value pairs
4 participants