Update README with instructions for new version #481
Merged
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
There was a problem hiding this comment.
Pull request overview
This pull request updates the README documentation to reflect migration from ESLint's legacy .eslintrc configuration format to the new flat config format introduced in ESLint v9. The documentation now instructs users to create eslint.config.mjs files instead of .eslintrc files.
Changes:
- Updated all configuration examples to use ESLint v9's flat config format with
eslint.config.mjsfiles - Removed references to the old
.eslintrcconfiguration format and@rushstack/eslint-patchworkaround - Added clarification that the plugin requires ESLint v9+ and uses flat config format
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Updated installation and configuration instructions for all presets (JavaScript, TypeScript, React, Cypress) to use flat config format; added custom rules example; fixed typo ("for" → "of") |
| docs/README.md | Updated preset configuration examples to use flat config format; added missing period in Cypress section description |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 description provided.