Skip to content

docs: Update README#92

Merged
mdjermanovic merged 2 commits intomainfrom
readme-update
Oct 7, 2022
Merged

docs: Update README#92
mdjermanovic merged 2 commits intomainfrom
readme-update

Conversation

@nzakas
Copy link
Copy Markdown
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
Comment thread README.md Outdated
Comment on lines +24 to +25
import pkg from "@eslint/eslintrc";
const { FlatCompat } = pkg;
Copy link
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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
Copy Markdown

@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
Copy Markdown
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