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

Document a preference for starting from scratch #325

Closed
JoshuaKGoldberg opened this issue Feb 11, 2020 · 1 comment
Closed

Document a preference for starting from scratch #325

JoshuaKGoldberg opened this issue Feb 11, 2020 · 1 comment
Assignees
Labels
documentation Improvements or additions to docs status: accepting prs Please, send in a PR to resolve this! ✨ type: bug Something isn't working

Comments

@JoshuaKGoldberg
Copy link
Member

Overview

I've been suggesting to people on Twitter (and @beenotung mentioned something like this too) that if they have the time, the most pleasant way to convert from TSLint to ESLint is:

  1. Delete any existing TSLint configurations and uninstall its packages
  2. Install the eslint, @typescript-eslint/parser, and @typescript-eslint/eslint-plugin packages
  3. Create an .eslintrc.js file that extends from @typescript-eslint/recommended
  4. Run ESLint on your files
  5. Disable any newly complaining ESLint rule in your .eslintrc.js and file an issue/ticket/what-have-you to get back to it later

Actual Behavior

No such documentation, which implies that directly using this package is the recommended way to convert.

Expected Behavior

This package works best when you have a very finely tuned TSLint configuration and not enough time to start from scratch. But, TSLint has some legacy recommendations in its rules, and not starting from scratch means you might miss out on some great new rules.

@JoshuaKGoldberg JoshuaKGoldberg added type: bug Something isn't working documentation Improvements or additions to docs status: accepting prs Please, send in a PR to resolve this! ✨ labels Feb 11, 2020
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Feb 11, 2020
@JoshuaKGoldberg
Copy link
Member Author

Oh, funny, I already filed an equivalent of this issue! 😅 Dup of #301.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to docs status: accepting prs Please, send in a PR to resolve this! ✨ type: bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant