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: Add article about restrict-plus-operands & restrict-template-expressions best practices #6758

Open
2 tasks done
JoshuaKGoldberg opened this issue Mar 24, 2023 · 0 comments
Assignees
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

Forking from @bradzacher's #6110 (comment) (context: adding more allow* options to restrict-plus-operands):

I'm unhappy, but won't block the addition of an option - but I think that we need to clearly document the caveat that it severely weakens the rule to the point that all it bans is string + nullish.

I think we should document alternatives and better patterns to use to help guide users towards better code because better code means you can have a stricter rule and a better codebase.

Agreed - I too am unhappy!

I think this is a common & deep enough documentation need that it makes sense to have a blog post explaining these things. And @bradzacher I think you're best positioned to write it 😄

(or, if you don't have the time, a scraping of all your posts on that issue & related issues+PRs might do...)

Affected URL(s)

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

@JoshuaKGoldberg JoshuaKGoldberg added triage Waiting for maintainers to take a look documentation Documentation ("docs") that needs adding/updating labels Mar 24, 2023
@JoshuaKGoldberg JoshuaKGoldberg added accepting prs Go ahead, send a pull request that resolves this issue and removed triage Waiting for maintainers to take a look labels Apr 8, 2023
@JoshuaKGoldberg JoshuaKGoldberg added team assigned A member of the typescript-eslint team should work on this. and removed accepting prs Go ahead, send a pull request that resolves this issue labels Jun 4, 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