docs: Explicitly mention flat config for findability #190
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.
No linked issue.
What Changed
This PR adds an explicit mention of "flat config" in the flat config section.
Why?
I often search for 'flat config' when taking over a project and having to decide if it's ready to upgrade to ESLint 9. When I looked at this plugin today, I parsed the README quickly and initially missed the flat config section. I had to check the dependencies to see that it supports ESLint 9.
Many major ESLint plugins use the word flat somewhere in their description of this new config:
The ones that don't:
Using the explicit wording in the relevant section ensures a ^+F search finds a match, since not finding anything when searching for "flat" could lead users to wrongly assume that ESLint 9 is not supported.
Checklist
Check the ones applicable to your change:
Ranpnpm run update-all
Tests are updatedChange Type
Indicate the type of change your pull request is:
maintenance
documentation
patch
minor
major