docs: add an example on how to use custom parser with flat config #2490
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
ota-meshi
requested changes
Jun 30, 2024
docs/user-guide/index.md
Outdated
|
|
||
| ::: code-group | ||
|
|
||
| ```json [Legacy Config] |
Member
There was a problem hiding this comment.
Thanks for the PR!
I think we'll avoid using the terms "Legacy Config" and "Flat Config" in our documentation.
Could you please change it to use .eslintrc and eslint.config.js instead?
Contributor
Author
There was a problem hiding this comment.
Sure thing! I saw the same naming convention elsewhere in the docs, I changed those too^^
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Related to: #2448
📚 Description
This PR adds an example on how to use this plugin with TypeScript, which is a common use case.
📜 Notes
The getting started guide is getting a bit hard to follow with a lot of warnings, duplicated text for each configuration style. It might worth extracting the
.eslintrcformat to a different subpage like it is done in the official eslint docs.