feat(eslint-plugin): add extension rule `space-before-blocks` (#1606) #4184

FDIM · 2021-11-18T22:26:22Z

PR Checklist

Addresses an existing issue: fixes Missing spaces around name interface and type #1606
That issue was marked as accepting prs
Steps in CONTRIBUTING.md were taken

Overview

I've added an extension rule for space-before-blocks that ensures that space before curly brace is enforced for enums and interfaces.

I'll add rule documentation file a bit later and in the meantime, feedback on PR is welcome as I'm not too familiar with this code base. Most specifically if there is any better way of handling schema without copying & extending. (PR is ready)

Impressive local setup, even debugging via vscode just worked!

EDIT: and even more impressive setup in CI, unit test for missing doc file was a nice surprise.

typescript-eslint · 2021-11-18T22:26:26Z

Thanks for the PR, @FDIM!

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.

netlify · 2021-11-18T22:26:30Z

❌ Deploy Preview for typescript-eslint failed.

🔨 Explore the source changes: cd06e6a

🔍 Inspect the deploy log: https://app.netlify.com/sites/typescript-eslint/deploys/621783f450188400074b338d

nx-cloud · 2021-11-18T22:28:11Z

☁️ Nx Cloud Report

CI ran the following commands for commit cd06e6a. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

✅ Successfully ran 48 targets

Sent with 💌 from NxCloud.

codecov · 2021-11-20T20:47:49Z

Codecov Report

Merging #4184 (cd06e6a) into main (823b945) will decrease coverage by 0.18%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main    #4184      +/-   ##
==========================================
- Coverage   94.62%   94.44%   -0.19%     
==========================================
  Files         149      155       +6     
  Lines        8072     8312     +240     
  Branches     2581     2647      +66     
==========================================
+ Hits         7638     7850     +212     
- Misses        239      261      +22     
- Partials      195      201       +6

Flag	Coverage Δ
unittest	`94.44% <100.00%> (-0.19%)`	⬇️

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

Impacted Files	Coverage Δ
packages/eslint-plugin/src/configs/all.ts	`100.00% <ø> (ø)`
...ckages/eslint-plugin/src/util/getESLintCoreRule.ts	`75.00% <ø> (ø)`
...ges/eslint-plugin/src/rules/space-before-blocks.ts	`100.00% <100.00%> (ø)`
...gin-internal/src/rules/no-poorly-typed-ts-props.ts	`88.88% <0.00%> (ø)`
...lugin-internal/src/rules/plugin-test-formatting.ts	`84.32% <0.00%> (ø)`
...internal/src/rules/no-typescript-default-import.ts	`100.00% <0.00%> (ø)`
...plugin-internal/src/rules/prefer-ast-types-enum.ts	`91.30% <0.00%> (ø)`
...-internal/src/rules/no-typescript-estree-import.ts	`87.50% <0.00%> (ø)`

JoshuaKGoldberg

LGTM in general -- thanks for adding this in @FDIM! ❤️‍🔥

I'm not particularly familiar with extension rules yet so I'll defer to @bradzacher or another maintainer.

Just requesting changes on a few type system and API usage fixups.

packages/eslint-plugin/docs/rules/space-before-blocks.md

packages/eslint-plugin/src/rules/space-before-blocks.ts

bradzacher

all josh's comments are on point!
otherwise looks to be extended appropriately

packages/eslint-plugin/src/rules/space-before-blocks.ts

JoshuaKGoldberg

Just the one thing on supporting older ESLint versions, otherwise 💯 !

Edit: and merging in from the main branch, if you don't mind 😄

JoshuaKGoldberg · 2022-01-23T23:36:47Z

Btw there's no need to force push. We squash PR commits. Force pushing makes it a little harder to review in some cases not hit by this PR for us.

FDIM · 2022-02-13T19:29:33Z

@JoshuaKGoldberg It should be ready again :D And sorry taking this long and for force pushing, got into this habit when working a small PRs for angular.

packages/eslint-plugin/src/rules/space-before-blocks.ts

JoshuaKGoldberg · 2022-02-13T19:44:00Z

I've always been more of a React dev myself... 😜

JoshuaKGoldberg

Sorry, still very close! 😄

But thanks for coming back to this! There are some introduced unit test failures due to merging in updated tests & documentation standards from main you'll want to clean up. Let me know if you don't have time and I can help. ❤️

packages/eslint-plugin/docs/rules/space-before-blocks.md

…ript-eslint#1606)

FDIM · 2022-02-13T20:50:34Z

@JoshuaKGoldberg few iterations later, everything should finally be good 😄

JoshuaKGoldberg

Super, thanks @FDIM! ✨

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.12.1` -> `5.13.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2feslint-plugin/5.12.1/5.13.0) | | [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.12.1` -> `5.13.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2fparser/5.12.1/5.13.0) | --- ### Release Notes <details> <summary>typescript-eslint/typescript-eslint (@typescript-eslint/eslint-plugin)</summary> ### [`v5.13.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#5130-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5121v5130-2022-02-28) [Compare Source](typescript-eslint/typescript-eslint@v5.12.1...v5.13.0) ##### Bug Fixes - **eslint-plugin:** \[sort-type-union-intersection-members] Wrap the constructorType in parentheses ([#4590](typescript-eslint/typescript-eslint#4590)) ([851bb90](typescript-eslint/typescript-eslint@851bb90)) ##### Features - **eslint-plugin:** \[no-misused-promises] check more places for checksVoidReturn ([#4541](typescript-eslint/typescript-eslint#4541)) ([052cf51](typescript-eslint/typescript-eslint@052cf51)) - **eslint-plugin:** add `no-redundant-type-constituents` rule ([#4378](typescript-eslint/typescript-eslint#4378)) ([63d051e](typescript-eslint/typescript-eslint@63d051e)) - **eslint-plugin:** add `no-useless-empty-export` rule ([#4380](typescript-eslint/typescript-eslint#4380)) ([823b945](typescript-eslint/typescript-eslint@823b945)) - **eslint-plugin:** add extension rule `space-before-blocks` ([#1606](typescript-eslint/typescript-eslint#1606)) ([#4184](typescript-eslint/typescript-eslint#4184)) ([208b6d0](typescript-eslint/typescript-eslint@208b6d0)) - **eslint-plugin:** added member group support to member-ordering rule ([#4538](typescript-eslint/typescript-eslint#4538)) ([6afcaea](typescript-eslint/typescript-eslint@6afcaea)) #### [5.12.1](typescript-eslint/typescript-eslint@v5.12.0...v5.12.1) (2022-02-21) ##### Bug Fixes - **eslint-plugin:** \[no-unnecessary-type-arguments] fix comparison of types ([#4555](typescript-eslint/typescript-eslint#4555)) ([fc3936e](typescript-eslint/typescript-eslint@fc3936e)) </details> <details> <summary>typescript-eslint/typescript-eslint (@typescript-eslint/parser)</summary> ### [`v5.13.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#5130-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5121v5130-2022-02-28) [Compare Source](typescript-eslint/typescript-eslint@v5.12.1...v5.13.0) **Note:** Version bump only for package [@typescript-eslint/parser](https://github.com/typescript-eslint/parser) #### [5.12.1](typescript-eslint/typescript-eslint@v5.12.0...v5.12.1) (2022-02-21) **Note:** Version bump only for package [@typescript-eslint/parser](https://github.com/typescript-eslint/parser) </details> --- ### Configuration 📅 **Schedule**: At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Renovate will not automatically rebase this PR, because other commits have been found. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] If you want to rebase/retry this PR, click this checkbox. --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Co-authored-by: 6543 <6543@noreply.codeberg.org> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1192 Reviewed-by: 6543 <6543@noreply.codeberg.org> Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org> Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>

FDIM force-pushed the feat/space-before-blocks branch 7 times, most recently from 7d9b8d7 to 5f823df Compare November 20, 2021 20:47

bradzacher added the enhancement: new base rule extension New base rule extension required to handle a TS specific case label Nov 23, 2021

JoshuaKGoldberg requested changes Dec 18, 2021

View reviewed changes

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

bradzacher reviewed Dec 20, 2021

View reviewed changes

packages/eslint-plugin/src/rules/space-before-blocks.ts Show resolved Hide resolved

FDIM force-pushed the feat/space-before-blocks branch from 5f823df to 8d0404d Compare January 1, 2022 11:02

bradzacher removed the awaiting response Issues waiting for a reply from the OP or another party label Jan 1, 2022

FDIM force-pushed the feat/space-before-blocks branch from 8d0404d to 1dfad58 Compare January 10, 2022 10:18

JoshuaKGoldberg requested changes Jan 23, 2022

View reviewed changes

bradzacher added the awaiting response Issues waiting for a reply from the OP or another party label Jan 24, 2022

FDIM force-pushed the feat/space-before-blocks branch from 1dfad58 to 3bc8d53 Compare February 13, 2022 19:25

JoshuaKGoldberg reviewed Feb 13, 2022

View reviewed changes

packages/eslint-plugin/src/rules/space-before-blocks.ts Outdated Show resolved Hide resolved

JoshuaKGoldberg requested changes Feb 13, 2022

View reviewed changes

JoshuaKGoldberg reviewed Feb 13, 2022

View reviewed changes

packages/eslint-plugin/docs/rules/space-before-blocks.md Outdated Show resolved Hide resolved

FDIM force-pushed the feat/space-before-blocks branch from 3bc8d53 to 59d6cc4 Compare February 13, 2022 20:19

feat(eslint-plugin): add extension rule space-before-blocks (typesc…

0f55941

…ript-eslint#1606)

FDIM force-pushed the feat/space-before-blocks branch from 59d6cc4 to 0f55941 Compare February 13, 2022 20:40

bradzacher removed the awaiting response Issues waiting for a reply from the OP or another party label Feb 14, 2022

Merge branch 'main' into feat/space-before-blocks

cd06e6a

JoshuaKGoldberg approved these changes Feb 24, 2022

View reviewed changes

JoshuaKGoldberg merged commit 208b6d0 into typescript-eslint:main Feb 24, 2022

vuki656 mentioned this pull request Apr 13, 2022

Spacing around blocks RimacTechnology/eslint-config-rimac#9

Closed

github-actions bot locked as resolved and limited conversation to collaborators May 26, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(eslint-plugin): add extension rule `space-before-blocks` (#1606) #4184

feat(eslint-plugin): add extension rule `space-before-blocks` (#1606) #4184

FDIM commented Nov 18, 2021 •

edited

typescript-eslint bot commented Nov 18, 2021

netlify bot commented Nov 18, 2021 •

edited

nx-cloud bot commented Nov 18, 2021 •

edited

codecov bot commented Nov 20, 2021 •

edited

JoshuaKGoldberg left a comment

bradzacher left a comment

JoshuaKGoldberg left a comment •

edited

JoshuaKGoldberg commented Jan 23, 2022

FDIM commented Feb 13, 2022

JoshuaKGoldberg commented Feb 13, 2022

JoshuaKGoldberg left a comment

FDIM commented Feb 13, 2022

JoshuaKGoldberg left a comment

feat(eslint-plugin): add extension rule space-before-blocks (#1606) #4184

feat(eslint-plugin): add extension rule space-before-blocks (#1606) #4184

Conversation

FDIM commented Nov 18, 2021 • edited

PR Checklist

Overview

typescript-eslint bot commented Nov 18, 2021

netlify bot commented Nov 18, 2021 • edited

nx-cloud bot commented Nov 18, 2021 • edited

☁️ Nx Cloud Report

codecov bot commented Nov 20, 2021 • edited

Codecov Report

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

bradzacher left a comment

Choose a reason for hiding this comment

JoshuaKGoldberg left a comment • edited

Choose a reason for hiding this comment

JoshuaKGoldberg commented Jan 23, 2022

FDIM commented Feb 13, 2022

JoshuaKGoldberg commented Feb 13, 2022

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

FDIM commented Feb 13, 2022

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

feat(eslint-plugin): add extension rule `space-before-blocks` (#1606) #4184

feat(eslint-plugin): add extension rule `space-before-blocks` (#1606) #4184

FDIM commented Nov 18, 2021 •

edited

netlify bot commented Nov 18, 2021 •

edited

nx-cloud bot commented Nov 18, 2021 •

edited

codecov bot commented Nov 20, 2021 •

edited

JoshuaKGoldberg left a comment •

edited