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

Comment on the futility of directly copying configs in generated ESLint configs #301

Closed
JoshuaKGoldberg opened this issue Dec 22, 2019 · 0 comments · Fixed by #348
Closed
Assignees
Labels
documentation Improvements or additions to docs status: accepting prs Please, send in a PR to resolve this! ✨ type: enhancement New feature or request

Comments

@JoshuaKGoldberg
Copy link
Member

🚀 Feature Request

Now that this has been out in the wild before, a vague feeling of mine that auto-generated configs are inferior to starting from scratch has become a firm belief. I now recommend to people the following system:

  1. Start from scratch with typescript-eslint's recommended and recommend-requiring-type-checking rulesets
  2. Add a section to your config's 'rules' listing containing all rules you disabled because you don't want them
  3. Add a section to your config's 'rules' listing containing all rules that have any new errors, then file a ticket/issue/whatever-your-JIRA-equivalent-uses to enable each of them
  4. Repeat for any community rulesets you find that appeal to you - e.g. React-specific ESLint rules.

(see also #2 for recommending best practices around Prettier)

Existing Behavior

Generated configs and documentation contain no such comments, and so are implied to be best practice.

Change Proposal

Two things:

  1. Recommend this approach in the README.md
  2. Add comments on top of generated ESLint configs that mention them as auto-generated and inferior
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: enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant