Added usage and base configuration FAQs #348
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bradzacher
reviewed
Mar 30, 2020
adidahiya
reviewed
Mar 30, 2020
| **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. |
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.
maybe the first step in this ordered list should be actually using tslint-to-eslint-config?
There was a problem hiding this comment.
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!
bradzacher
reviewed
Mar 30, 2020
|
FYI @JoshuaKGoldberg I approved the request for renovate app |
Co-Authored-By: Brad Zacher <[email protected]>
Co-Authored-By: Brad Zacher <[email protected]>
This was referenced Apr 26, 2020
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Checklist
status: accepting prsOverview
Roughly per the issue, adds recommendations and links to docs in two places:
docs/FAQs.mdemphatically 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?