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

Added usage and base configuration FAQs #348

Merged
merged 8 commits into from
Mar 30, 2020
Merged

Added usage and base configuration FAQs #348

merged 8 commits into from
Mar 30, 2020

Conversation

JoshuaKGoldberg
Copy link
Member

PR Checklist

Overview

Roughly per the issue, adds recommendations and links to docs in two places:

  • A new docs/FAQs.md emphatically linked to in the README.md
  • A block comment at the beginning of the generated config file

Notes

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?

docs/FAQs.md Show resolved Hide resolved
docs/FAQs.md Outdated Show resolved Hide resolved
**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.

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)

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?

Copy link
Member Author

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!

docs/FAQs.md Outdated Show resolved Hide resolved
Copy link
Member

@JamesHenry JamesHenry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good stuff 👏

@JamesHenry
Copy link
Member

FYI @JoshuaKGoldberg I approved the request for renovate app

Josh Goldberg and others added 5 commits March 30, 2020 15:46
Co-Authored-By: Brad Zacher <brad.zacher@gmail.com>
Co-Authored-By: Brad Zacher <brad.zacher@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Comment on the futility of directly copying configs in generated ESLint configs
4 participants