feat(eslint-plugin): split no-empty-object-type out from ban-types and no-empty-interfaces #8977

JoshuaKGoldberg · 2024-04-23T19:25:02Z

BREAKING CHANGE:
Changes the default options of a lint rule

PR Checklist

Addresses an existing open issue: fixes Enhancement: [ban-types] Split the {} ban into a separate, better-phrased rule #8700
That issue was marked as accepting prs
Steps in Contributing were taken

Overview

Per #8700 (comment), splits out the banning of {} from the ban-types rule into a new no-empty-object-type rule.

…es rule

typescript-eslint · 2024-04-23T19:25:05Z

Thanks for the PR, @JoshuaKGoldberg!

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.

packages/eslint-plugin/docs/rules/no-empty-object-type.mdx

nx-cloud · 2024-04-23T19:26:59Z

☁️ Nx Cloud Report

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

📂 See all runs for this CI Pipeline Execution

✅ Successfully ran 31 targets

Sent with 💌 from NxCloud.

JoshuaKGoldberg · 2024-04-23T19:38:34Z

packages/eslint-plugin/src/rules/ban-types.ts

@@ -82,32 +85,6 @@ const defaultTypes: Types = {
      'If you are expecting the function to accept certain arguments, you should explicitly define the function shape.',
    ].join('\n'),
  },
-
-  // object typing
-  Object: {


We didn't explicitly discuss Object, but I think it makes sense in the spirit of this change to switch it to being treated as another banned uppercase alias. I've never seen people confuse Object for {}.

packages/eslint-plugin/docs/rules/no-empty-object-type.mdx

Co-authored-by: Kirk Waiblinger <53019676+kirkwaiblinger@users.noreply.github.com>

packages/eslint-plugin/docs/rules/no-empty-object-type.mdx

Co-authored-by: Kirk Waiblinger <53019676+kirkwaiblinger@users.noreply.github.com>

bradzacher · 2024-04-23T22:04:20Z

Mildly tangential - but I can envision the following options:

allowInTypeAliasWithName - for react codebases to allow type MyProps = {}
allowInIntersection - to allow type T = A & {} - wherein the {} falls away.
- does this even need an option...? Probably should be the default?

packages/eslint-plugin/src/rules/no-empty-object-type.ts

codecov · 2024-04-23T22:19:58Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.34%. Comparing base (04f1938) to head (39870f1).

❗ Current head 39870f1 differs from pull request most recent head 7dc88d7. Consider uploading reports for the commit 7dc88d7 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##               v8    #8977      +/-   ##
==========================================
- Coverage   87.43%   87.34%   -0.09%     
==========================================
  Files         386      387       +1     
  Lines       13069    13025      -44     
  Branches     3776     3769       -7     
==========================================
- Hits        11427    11377      -50     
- Misses       1353     1356       +3     
- Partials      289      292       +3

Flag	Coverage Δ
unittest	`87.34% <100.00%> (-0.09%)`	⬇️

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

Files	Coverage Δ
packages/eslint-plugin/src/rules/ban-types.ts	`95.83% <ø> (-4.17%)`	⬇️
...es/eslint-plugin/src/rules/no-empty-object-type.ts	`100.00% <100.00%> (ø)`

... and 33 files with indirect coverage changes

packages/eslint-plugin/docs/rules/no-empty-object-type.mdx

packages/eslint-plugin/docs/rules/no-empty-interface.mdx

JoshuaKGoldberg · 2024-04-26T13:41:53Z

standalone rule for v7

~~I like that a lot! Regardless of what we choose for no-empty-interface, this lets us get it released faster. Excellent. I'll get that PR up now.~~ Edit: actually, no, I'll wait a bit - maybe it wouldn't make sense.

packages/eslint-plugin/src/rules/no-empty-object-type.ts

bradzacher

general logic LGTM

packages/eslint-plugin/docs/rules/no-empty-object-type.mdx

Co-authored-by: Kirk Waiblinger <kirk.waiblinger@gmail.com>

packages/eslint-plugin/src/rules/no-empty-interface.ts

feat(eslint-plugin): split no-empty-object-type rule out from ban-typ…

bcfbb03

…es rule

JoshuaKGoldberg added this to the 8.0.0 milestone Apr 23, 2024

JoshuaKGoldberg commented Apr 23, 2024

View reviewed changes

packages/eslint-plugin/docs/rules/no-empty-object-type.mdx Show resolved Hide resolved

JoshuaKGoldberg commented Apr 23, 2024

View reviewed changes

packages/eslint-plugin/docs/rules/no-empty-object-type.mdx Show resolved Hide resolved

JoshuaKGoldberg marked this pull request as ready for review April 23, 2024 19:37

JoshuaKGoldberg requested review from bradzacher, kirkwaiblinger and Josh-Cena April 23, 2024 19:37

JoshuaKGoldberg commented Apr 23, 2024

View reviewed changes

packages/eslint-plugin/docs/rules/no-empty-object-type.mdx Show resolved Hide resolved

JoshuaKGoldberg mentioned this pull request Apr 23, 2024

Enhancement: [ban-types] Split into default-less no-restricted-types and more targeted type ban rule(s) #8978

Closed

bradzacher reviewed Apr 23, 2024

View reviewed changes

packages/eslint-plugin/docs/rules/no-empty-object-type.mdx Outdated Show resolved Hide resolved

Mention no-props

173251c

JoshuaKGoldberg requested a review from bradzacher April 23, 2024 21:11

kirkwaiblinger reviewed Apr 23, 2024

View reviewed changes

packages/eslint-plugin/docs/rules/no-empty-object-type.mdx Outdated Show resolved Hide resolved

Update packages/eslint-plugin/docs/rules/no-empty-object-type.mdx

b83cb50

Co-authored-by: Kirk Waiblinger <53019676+kirkwaiblinger@users.noreply.github.com>

kirkwaiblinger reviewed Apr 23, 2024

View reviewed changes

packages/eslint-plugin/docs/rules/no-empty-object-type.mdx Outdated Show resolved Hide resolved

Update packages/eslint-plugin/docs/rules/no-empty-object-type.mdx

39870f1

Co-authored-by: Kirk Waiblinger <53019676+kirkwaiblinger@users.noreply.github.com>

bradzacher reviewed Apr 23, 2024

View reviewed changes

packages/eslint-plugin/src/rules/no-empty-object-type.ts Show resolved Hide resolved

This comment was marked as resolved.

Sign in to view

JoshuaKGoldberg commented Apr 24, 2024

View reviewed changes

packages/eslint-plugin/docs/rules/no-empty-object-type.mdx Outdated Show resolved Hide resolved

JoshuaKGoldberg commented Apr 24, 2024

View reviewed changes

packages/eslint-plugin/docs/rules/no-empty-object-type.mdx Show resolved Hide resolved

Allow in intersections, and touch up docs per suggestions

f90ab3f

JoshuaKGoldberg commented Apr 24, 2024

View reviewed changes

packages/eslint-plugin/docs/rules/no-empty-interface.mdx Outdated Show resolved Hide resolved

JoshuaKGoldberg requested review from kirkwaiblinger and bradzacher April 24, 2024 12:43

JoshuaKGoldberg marked this pull request as draft April 26, 2024 13:42

JoshuaKGoldberg added 2 commits April 30, 2024 02:01

Merge with no-empty-interface

e8a2d7f

nit the tip

3971d71

bradzacher reviewed May 3, 2024

View reviewed changes

packages/eslint-plugin/src/rules/no-empty-object-type.ts Outdated Show resolved Hide resolved

bradzacher approved these changes May 3, 2024

View reviewed changes

JoshuaKGoldberg requested review from Josh-Cena, bradzacher and kirkwaiblinger May 8, 2024 15:36

Explicit report message for interfaces

d33a246

JoshuaKGoldberg marked this pull request as ready for review May 8, 2024 15:36

kirkwaiblinger approved these changes May 8, 2024

View reviewed changes

JoshuaKGoldberg added 6 commits May 8, 2024 18:59

Add in-type-alias-with-name

28ed70d

Switched to more general allowWithName

9b6dd1a

Merge branch 'v8'

e0bbd1d

snapshot -u

b7a70b8

snapshot -u

713404a

Fixed up unit tests

218d8e5

JoshuaKGoldberg requested a review from kirkwaiblinger May 10, 2024 01:06

kirkwaiblinger reviewed May 10, 2024

View reviewed changes

JoshuaKGoldberg and others added 2 commits May 11, 2024 18:22

Update packages/eslint-plugin/docs/rules/no-empty-object-type.mdx

9987c2b

Co-authored-by: Kirk Waiblinger <kirk.waiblinger@gmail.com>

docs touchups from Kirk

bd764ef

JoshuaKGoldberg changed the title ~~feat(eslint-plugin): split no-empty-object-type rule out from ban-types rule~~ feat(eslint-plugin): split no-empty-object-type out from ban-types and no-empty-interfaces May 12, 2024

bradzacher approved these changes May 12, 2024

View reviewed changes

packages/eslint-plugin/src/rules/no-empty-interface.ts Show resolved Hide resolved

replacedBy too

7dc88d7

JoshuaKGoldberg merged commit fd097ef into typescript-eslint:v8 May 12, 2024
58 checks passed

JoshuaKGoldberg deleted the no-empty-object-type branch May 12, 2024 05:42

This was referenced May 12, 2024

Enhancement: [ban-types] Split the {} ban into a separate, better-phrased rule #8700

Closed

Docs: Write blog post on the history of ban-types, {}, and object/Object #9103

Open

github-actions bot locked as resolved and limited conversation to collaborators May 21, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(eslint-plugin): split no-empty-object-type out from ban-types and no-empty-interfaces #8977

feat(eslint-plugin): split no-empty-object-type out from ban-types and no-empty-interfaces #8977

JoshuaKGoldberg commented Apr 23, 2024 •

edited

Loading

typescript-eslint bot commented Apr 23, 2024

nx-cloud bot commented Apr 23, 2024 •

edited

Loading

JoshuaKGoldberg Apr 23, 2024

bradzacher commented Apr 23, 2024

This comment was marked as resolved.

codecov bot commented Apr 23, 2024 •

edited

Loading

JoshuaKGoldberg commented Apr 26, 2024 •

edited

Loading

bradzacher left a comment

feat(eslint-plugin): split no-empty-object-type out from ban-types and no-empty-interfaces #8977

feat(eslint-plugin): split no-empty-object-type out from ban-types and no-empty-interfaces #8977

Conversation

JoshuaKGoldberg commented Apr 23, 2024 • edited Loading

PR Checklist

Overview

typescript-eslint bot commented Apr 23, 2024

nx-cloud bot commented Apr 23, 2024 • edited Loading

☁️ Nx Cloud Report

JoshuaKGoldberg Apr 23, 2024

Choose a reason for hiding this comment

bradzacher commented Apr 23, 2024

This comment was marked as resolved.

codecov bot commented Apr 23, 2024 • edited Loading

Codecov Report

JoshuaKGoldberg commented Apr 26, 2024 • edited Loading

bradzacher left a comment

Choose a reason for hiding this comment

JoshuaKGoldberg commented Apr 23, 2024 •

edited

Loading

nx-cloud bot commented Apr 23, 2024 •

edited

Loading

codecov bot commented Apr 23, 2024 •

edited

Loading

JoshuaKGoldberg commented Apr 26, 2024 •

edited

Loading