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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
2 tasks done
JoshuaKGoldberg opened this issue May 15, 2024 · 1 comment
Open
2 tasks done
Labels
documentation Documentation ("docs") that needs adding/updating team assigned A member of the typescript-eslint team should work on this.

Comments

@JoshuaKGoldberg
Copy link
Member

Before You File a Documentation Request Please Confirm You Have Done The Following...

Suggested Changes

One of the particularly exciting changes in our upcoming v8 version is us finally fixing up messaging around the {} (empty object type). It's long been a contentious part of the ban-types rule:

  • On the one hand, {} is a confusing type that a lot of TS devs get tripped up over
  • On the other hand, there are legitimate use cases for it, and banning it outright is too string

We think we've reached a good compromise for v8 with the combination of:

This has been a long journey with lots of discussion (#8700 is just one of many!). It seems ripe for a blog post to me!

💖

Affected URL(s)

https://typescript-eslint.io/blog/*

Note that if this is accepted, I think a member of our team should write the post. It's not something an external contributor could easily do. Blog posts are tricky.

@JoshuaKGoldberg JoshuaKGoldberg added triage Waiting for maintainers to take a look documentation Documentation ("docs") that needs adding/updating labels May 15, 2024
@Josh-Cena
Copy link
Member

Yes, I think there's a lot of room for education here in the blog post...

@JoshuaKGoldberg JoshuaKGoldberg added team assigned A member of the typescript-eslint team should work on this. and removed triage Waiting for maintainers to take a look labels Jun 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation ("docs") that needs adding/updating team assigned A member of the typescript-eslint team should work on this.
Projects
None yet
Development

No branches or pull requests

2 participants