docs: Update README #92
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
aladdin-add
reviewed
Sep 8, 2022
README.md
Outdated
Comment on lines
24
to
25
| import pkg from "@eslint/eslintrc"; | ||
| const { FlatCompat } = pkg; |
There was a problem hiding this comment.
looks like the original code example is correct. it was using named exports:
Lines 50 to 56 in 99adbac
There was a problem hiding this comment.
We had a report that regular names imports weren’t working so we changed other examples to this format for best compatibility.
There was a problem hiding this comment.
no, it's just another case. eslint is a commonjs package, so users have do so, but this one does have an esm exports. It won't work to import like this.
There was a problem hiding this comment.
Ah right, thanks. I’ll fix this back to the original.
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.
Adds a note that we are no longer making changes except for critical bug fixes and also fixes the example code.