feat(eslint-plugin): [block-spacing] extending base rule for TS related blocks #6195

omril1 · 2022-12-09T23:01:05Z

PR Checklist

Addresses an existing open issue: fixes Base rule extension: block-spacing Extending base rule for TS related blocks #5990
That issue was marked as accepting prs
Steps in CONTRIBUTING.md were taken

Overview

nx-cloud · 2022-12-09T23:01:08Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit b6b1140. 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.

typescript-eslint · 2022-12-09T23:01:08Z

Thanks for the PR, @omril1!

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.

netlify · 2022-12-09T23:01:09Z

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	`b6b1140`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/63e2b17a51195400070fd8b3
😎 Deploy Preview	https://deploy-preview-6195--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

omril1 · 2022-12-09T23:06:58Z

packages/eslint-plugin/src/rules/block-spacing.ts

+      // This is the only change made here from the base rule
+      return sourceCode.getFirstToken(node, {
+        filter: token =>
+          token.type === AST_TOKEN_TYPES.Punctuator && token.value == '{',
+      }) as TSESTree.PunctuatorToken;


The only significant change from the base rule, it worked flawlessly for interface and object type literal.
Added a filter for punctuator because enums don't have a body node in the AST

https://github.com/eslint/eslint/blob/3ae0574fc78c4a2b406625e4792cb2859cb9bcb1/lib/rules/block-spacing.js#L60

omril1 · 2022-12-09T23:09:06Z

packages/eslint-plugin/src/rules/block-spacing.ts

+      TSInterfaceBody: baseRules.BlockStatement as never,
+      TSTypeLiteral: baseRules.BlockStatement as never,
+      TSEnumDeclaration: checkSpacingInsideBraces,


Kept the base rule for interface and type literal, though changing to checkSpacingInsideBraces will work as well

codecov · 2022-12-10T00:25:32Z

Codecov Report

Merging #6195 (b6b1140) into main (a9cb860) will increase coverage by 0.02%.
The diff coverage is 100.00%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #6195      +/-   ##
==========================================
+ Coverage   91.53%   91.55%   +0.02%     
==========================================
  Files         371      372       +1     
  Lines       12662    12701      +39     
  Branches     3721     3733      +12     
==========================================
+ Hits        11590    11629      +39     
  Misses        754      754              
  Partials      318      318

Flag	Coverage Δ
unittest	`91.55% <100.00%> (+0.02%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
...ckages/eslint-plugin/src/util/getESLintCoreRule.ts	`75.00% <ø> (ø)`
packages/eslint-plugin/src/rules/block-spacing.ts	`100.00% <100.00%> (ø)`

JoshuaKGoldberg

Mostly looks great to me! Just some touchups around untested code, and a few nitpicks. Thanks for sending this in & working on it! ✨

packages/eslint-plugin/src/rules/block-spacing.ts

packages/eslint-plugin/tests/rules/block-spacing.test.ts

omril1 · 2022-12-16T23:48:18Z

Sorry for the force push, something in vscode messed up my commits again

JoshuaKGoldberg

Looks great to me, thanks for sending this in!

Because this is an extension of a base rule, I'd feel more comfortable getting a review from another maintainer. Just to be safe 😄 .

…nd-base-block-spacing

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.51.0` -> `5.52.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2feslint-plugin/5.51.0/5.52.0) | | [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.51.0` -> `5.52.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2fparser/5.51.0/5.52.0) | --- ### Release Notes <details> <summary>typescript-eslint/typescript-eslint (@typescript-eslint/eslint-plugin)</summary> ### [`v5.52.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#5520-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5510v5520-2023-02-13) [Compare Source](typescript-eslint/typescript-eslint@v5.51.0...v5.52.0) ##### Bug Fixes - **eslint-plugin:** \[no-import-type-side-effects] correctly ignore zero-specifier imports ([#6444](typescript-eslint/typescript-eslint#6444)) ([d5a6688](typescript-eslint/typescript-eslint@d5a6688)) - **eslint-plugin:** \[no-unnecessary-condition] account for optional chaining on potentially void values ([#6432](typescript-eslint/typescript-eslint#6432)) ([e1d9c67](typescript-eslint/typescript-eslint@e1d9c67)), closes [#5255](typescript-eslint/typescript-eslint#5255) - **eslint-plugin:** \[no-unnecessary-condition] fix false positive when checking indexed access types ([#6452](typescript-eslint/typescript-eslint#6452)) ([d569924](typescript-eslint/typescript-eslint@d569924)) - **eslint-plugin:** fix key-spacing when type starts on next line ([#6412](typescript-eslint/typescript-eslint#6412)) ([3eb2eed](typescript-eslint/typescript-eslint@3eb2eed)) ##### Features - **eslint-plugin:** \[block-spacing] extending base rule for TS related blocks ([#6195](typescript-eslint/typescript-eslint#6195)) ([b2db3f5](typescript-eslint/typescript-eslint@b2db3f5)) - **eslint-plugin:** \[explicit-function-return-type] add allowFunctionsWithoutTypeParameters option ([#6105](typescript-eslint/typescript-eslint#6105)) ([113640e](typescript-eslint/typescript-eslint@113640e)) - **eslint-plugin:** \[explicit-function-return-type] add allowIIFEs option ([#6237](typescript-eslint/typescript-eslint#6237)) ([a1b3f7b](typescript-eslint/typescript-eslint@a1b3f7b)) </details> <details> <summary>typescript-eslint/typescript-eslint (@typescript-eslint/parser)</summary> ### [`v5.52.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#5520-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5510v5520-2023-02-13) [Compare Source](typescript-eslint/typescript-eslint@v5.51.0...v5.52.0) **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. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1784 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>

Omri Luzon added 9 commits December 9, 2022 23:15

feat/issue5990-extend-base-block-spacing

14ec73d

for history

f393928

fixes

0067b46

cleanup

7e8b540

with a comment for the option

3cd0d6f

support enums as well

590d9f8

template string

ab64e29

fix doc

65fa0e6

fix doc

d38b80e

omril1 commented Dec 9, 2022

View reviewed changes

omril1 changed the title ~~feat(eslint-plugin): [block-spacing] Extending base rule for TS related blocks~~ feat(eslint-plugin): [block-spacing] extending base rule for TS related blocks Dec 9, 2022

typescript -> TypeScript

dbe273c

omril1 marked this pull request as draft December 9, 2022 23:27

add missing things

2496815

omril1 marked this pull request as ready for review December 10, 2022 00:36

JoshuaKGoldberg requested changes Dec 16, 2022

View reviewed changes

JoshuaKGoldberg added the awaiting response Issues waiting for a reply from the OP or another party label Dec 16, 2022

Omri Luzon added 5 commits December 17, 2022 01:44

CR: remove jsdoc types

21a44fa

rename typeDeclaration -> typeDeclarations

82ec70d

more valid cases with comments

cef520c

invalid cases with block comments

415733a

more concise

725d8a9

omril1 force-pushed the feat/issue5990-extend-base-block-spacing branch from 276aef1 to 725d8a9 Compare December 16, 2022 23:45

Merge branch 'main' into feat/issue5990-extend-base-block-spacing

682503d

omril1 requested a review from JoshuaKGoldberg December 17, 2022 17:17

JoshuaKGoldberg previously approved these changes Dec 17, 2022

View reviewed changes

JoshuaKGoldberg requested a review from a team December 17, 2022 19:47

JoshuaKGoldberg added triage Waiting for maintainers to take a look and removed awaiting response Issues waiting for a reply from the OP or another party labels Dec 17, 2022

omril1 dismissed JoshuaKGoldberg’s stale review via ab3911e December 22, 2022 05:15

fix comment

6fd6ffb

omril1 force-pushed the feat/issue5990-extend-base-block-spacing branch from ab3911e to 6fd6ffb Compare December 24, 2022 12:19

Merge remote-tracking branch 'upstream/main' into feat/issue5990-exte…

7f9b654

…nd-base-block-spacing

JoshuaKGoldberg added the 1 approval PR that a maintainer has LGTM'd - any maintainer can merge this when ready label Dec 30, 2022

Omri Luzon added 6 commits January 1, 2023 10:49

Merge branch 'main' into feat/issue5990-extend-base-block-spacing

fe35cab

Merge branch 'main' into feat/issue5990-extend-base-block-spacing

679e13f

Merge remote-tracking branch 'upstream/main' into feat/issue5990-exte…

e215ca0

…nd-base-block-spacing

Merge branch 'main' into feat/issue5990-extend-base-block-spacing

9ccdd26

Merge remote-tracking branch 'upstream/main' into feat/issue5990-exte…

c149a12

…nd-base-block-spacing

fix lint error

b6b1140

bradzacher approved these changes Feb 13, 2023

View reviewed changes

bradzacher added this pull request to the merge queue Feb 13, 2023

Merged via the queue into typescript-eslint:main with commit b2db3f5 Feb 13, 2023

omril1 deleted the feat/issue5990-extend-base-block-spacing branch February 13, 2023 04:49

github-actions bot locked as resolved and limited conversation to collaborators Feb 21, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(eslint-plugin): [block-spacing] extending base rule for TS related blocks #6195

feat(eslint-plugin): [block-spacing] extending base rule for TS related blocks #6195

omril1 commented Dec 9, 2022

nx-cloud bot commented Dec 9, 2022 •

edited

typescript-eslint bot commented Dec 9, 2022

netlify bot commented Dec 9, 2022 •

edited

omril1 Dec 9, 2022

omril1 Dec 9, 2022

codecov bot commented Dec 10, 2022 •

edited

JoshuaKGoldberg left a comment

omril1 commented Dec 16, 2022

JoshuaKGoldberg left a comment

feat(eslint-plugin): [block-spacing] extending base rule for TS related blocks #6195

feat(eslint-plugin): [block-spacing] extending base rule for TS related blocks #6195

Conversation

omril1 commented Dec 9, 2022

PR Checklist

Overview

nx-cloud bot commented Dec 9, 2022 • edited

☁️ Nx Cloud Report

typescript-eslint bot commented Dec 9, 2022

netlify bot commented Dec 9, 2022 • edited

✅ Deploy Preview for typescript-eslint ready!

omril1 Dec 9, 2022

Choose a reason for hiding this comment

omril1 Dec 9, 2022

Choose a reason for hiding this comment

codecov bot commented Dec 10, 2022 • edited

Codecov Report

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

omril1 commented Dec 16, 2022

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

nx-cloud bot commented Dec 9, 2022 •

edited

netlify bot commented Dec 9, 2022 •

edited

codecov bot commented Dec 10, 2022 •

edited