docs: mention strict and stylistic configs in Getting Started #8916
Conversation
|
Thanks for the PR, @JoshuaKGoldberg! typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community. The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately. Thanks again! 🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. |
✅ Deploy Preview for typescript-eslint ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
|
||
| You're using an outdated version of `@typescript-eslint/parser`. | ||
| Update to the latest version to see a more informative version of this error message, explained in our [Troubleshooting and FAQs page](../troubleshooting/FAQ.mdx#i-get-errors-telling-me-eslint-was-configured-to-run--however-that-tsconfig-does-not--none-of-those-tsconfigs-include-this-file). | ||
|
|
There was a problem hiding this comment.
This hasn't been the error message format for quite a while, and closely matches the one mentioned in the frequently-linked-to troubleshooting docs. I feel comfortable removing this legacy affordance to take up less space on the page.
| ```js title=".eslintrc.cjs" | ||
| /* eslint-env node */ | ||
| module.exports = { | ||
| extends: [ | ||
| 'eslint:recommended', | ||
| // Remove this line | ||
| 'plugin:@typescript-eslint/recommended', | ||
| // Added lines start | ||
| 'plugin:@typescript-eslint/strict', | ||
| 'plugin:@typescript-eslint/stylistic', | ||
| // Added lines end | ||
| ], | ||
| parser: '@typescript-eslint/parser', | ||
| plugins: ['@typescript-eslint'], | ||
| root: true, | ||
| }; | ||
| ``` |
There was a problem hiding this comment.
I don't know if we should include a config block in here?
People will follow the bouncing ball and just do it without thinking... Which is a good and a bad thing.
There was a problem hiding this comment.
@bradzacher what do you mean by "include a config block"?
There was a problem hiding this comment.
The code block itself.
Its big and so it makes the section stand out more.
There was a problem hiding this comment.
Ah gotcha. Hmm. I like having it here - if they've reached this far I think they're high enough intent that I'd think they're probably being a little more careful in what they're doing. I don't think diffs are a likely ball bounce for them to ... bounce along with.
a197ac2
Co-authored-by: Kirk Waiblinger <53019676+kirkwaiblinger@users.noreply.github.com>
PR Checklist
Overview
Adds
### Additional Configssections to the flat and legacy config setup guides that mention strict & stylistic, followed by### Typed Lintingfor the existing links to that page.Applies a bit of streamlining/tightening to the pages to try to offset the added verbosity.
💖