-
Notifications
You must be signed in to change notification settings - Fork 100
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
Added usage and base configuration FAQs #348
Conversation
**Formatters** such as [Prettier](https://prettier.io) do a [much better job](https://prettier.io/docs/en/why-prettier.html) of formatting your code. | ||
See [this issue](https://github.com/typescript-eslint/typescript-eslint/issues/880) for more explanation. | ||
|
||
The maintenance teams at both TSLint and typescript-eslint recommend using a formatter such as Prettier to format your code instead of a linter. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
docs/FAQs.md
Outdated
|
||
Our recommended TSLint-to-ESLint configuration migration approach is: | ||
|
||
1. Switch your configuration to extend from [typescript-eslint's `recommended` and `recommend-requiring-type-checking` rulesets](https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/README.md) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe the first step in this ordered list should be actually using tslint-to-eslint-config
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Haha I was actually in the headspace of not doing that, since I've been just starting from scratch... but I can see how that would be a confusing recommendation. Plus a lot of the folks I've talked to consider starting from scratch a much more time-intensive, collaborative process than switching minimally... will edit!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good stuff 👏
FYI @JoshuaKGoldberg I approved the request for renovate app |
Co-Authored-By: Brad Zacher <brad.zacher@gmail.com>
Co-Authored-By: Brad Zacher <brad.zacher@gmail.com>
PR Checklist
status: accepting prs
Overview
Roughly per the issue, adds recommendations and links to docs in two places:
docs/FAQs.md
emphatically linked to in the README.mdNotes
FYI @adidahiya @bradzacher @JamesHenry - I wouldn't feel comfortable speaking on behave of either maintenance team without checking in 😄. Does this phrasing look good to you?