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

[JoshuaKGoldberg]

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.

[typescript-eslint]

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.

[nx-cloud]

☁️ 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

• nx test eslint-plugin --coverage=false
• nx test eslint-plugin
• nx test typescript-estree --coverage=false
• nx test scope-manager --coverage=false
• nx run types:build
• nx test visitor-keys --coverage=false
• nx run repo-tools:postinstall-script
• nx test type-utils --coverage=false
• nx test typescript-eslint --coverage=false
• nx test utils --coverage=false
• nx test rule-schema-to-typescript-types --coverage=false
• nx test repo-tools --coverage=false
• nx run-many --target=build --parallel --exclude=website --exclude=website-eslint
• nx test ast-spec --coverage=false
• nx test eslint-plugin-internal --coverage=false
• nx test parser --coverage=false
• nx run-many --target=lint --parallel --exclude eslint-plugin
• nx test typescript-estree
• nx test type-utils
• nx test eslint-plugin-internal
• nx test scope-manager
• nx test repo-tools
• nx test utils
• nx test visitor-keys
• nx test typescript-eslint
• nx test parser
• nx test rule-schema-to-typescript-types
• nx run integration-tests:test
• nx run-many --target=typecheck --parallel
• nx test ast-spec
• nx run repo-tools:generate-configs

---

Sent with 💌 from NxCloud.

[JoshuaKGoldberg]

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 {}.

[bradzacher]

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?

[codecov]

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

[bradzacher]

Also worth noting that we could land this as a standalone rule for v7 and then in v8 we change the defaults and make this new rule recommended.

That would allow us to do a deprecation of no-empty-interface this version and remove it in v8 - if we wanted to go that route.

[JoshuaKGoldberg]

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.

[bradzacher]

general logic LGTM

[kirkwaiblinger]

I think this list is stale now, due to the new option being added, right? Or, I guess, the way it's written, it doesn't seem to me like allowWithName is part of the list.

[JoshuaKGoldberg]

I'm having a hard time thinking of phrasing for this 🤔 do you have any suggestions @kirkwaiblinger?

[JoshuaKGoldberg]

Merged so that I can get other PRa going, but happy to take a followup issue or PR!