Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update README #92

Merged
merged 2 commits into from
Oct 7, 2022
Merged

docs: Update README #92

merged 2 commits into from
Oct 7, 2022

Conversation

nzakas
Copy link
Member

@nzakas nzakas commented Sep 8, 2022

Adds a note that we are no longer making changes except for critical bug fixes and also fixes the example code.

@eslint-github-bot eslint-github-bot bot added triage documentation Improvements or additions to documentation labels Sep 8, 2022
README.md Outdated
Comment on lines 24 to 25
import pkg from "@eslint/eslintrc";
const { FlatCompat } = pkg;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks like the original code example is correct. it was using named exports:

eslintrc/lib/index.js

Lines 50 to 56 in 99adbac

export {
Legacy,
FlatCompat
};

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We had a report that regular names imports weren’t working so we changed other examples to this format for best compatibility.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah right, thanks. I’ll fix this back to the original.

Copy link

@tdeo tdeo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the clarification

Copy link
Member

@mdjermanovic mdjermanovic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@mdjermanovic mdjermanovic merged commit adafd11 into main Oct 7, 2022
@mdjermanovic mdjermanovic deleted the readme-update branch October 7, 2022 10:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants