Skip to content

Use flat config for the project's eslint configuration#615

Merged
BPScott merged 2 commits intomasterfrom
localflatconfig
Dec 3, 2023
Merged

Use flat config for the project's eslint configuration#615
BPScott merged 2 commits intomasterfrom
localflatconfig

Conversation

@BPScott
Copy link
Copy Markdown
Member

@BPScott BPScott commented Dec 3, 2023 •
edited
Loading

Convert the project's eslint config to the flat style.

This shall let us dogfood the recommended eslint config when we add it.

This is a 1:1 migration, with the exception of adding .github/ISSUE_TEMPLATE.md to the ignores. I'm not sure what I've managed to do here, but it seems we weren't linting that before but now we are.

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Dec 3, 2023 •
edited
Loading

⚠️ No Changeset found

Latest commit: 88bb87e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@JounQin
Copy link
Copy Markdown
Member

JounQin commented Dec 3, 2023 •
edited
Loading

@BPScott .md files are linted by ESLint through remark-lint integration. And eslint-plugin-mdx supports flat config at the same time.

See also https://github.com/mdx-js/eslint-mdx/tree/master/packages/eslint-plugin-mdx#flat-config, https://github.com/mdx-js/eslint-mdx/tree/master/packages/eslint-plugin-mdx#mdxremark and https://github.com/prettier/eslint-plugin-prettier/blob/master/.remarkrc

JounQin
JounQin reviewed Dec 3, 2023
View reviewed changes
Comment thread package.json
JounQin
JounQin requested changes Dec 3, 2023
View reviewed changes
Copy link
Copy Markdown
Member

@JounQin JounQin left a comment

Choose a reason for hiding this comment

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

Please add mdx plugin back.

@BPScott
Copy link
Copy Markdown
Member Author

BPScott commented Dec 3, 2023

Gotcha, I hadn't clocked that eslint-plugin-mdx also lints against the markdowny portions of the markdown file rather than just the codeblocks. I'll add it back.

JounQin
JounQin reviewed Dec 3, 2023
View reviewed changes
Comment thread eslint.config.js
@BPScott BPScott requested a review from JounQin December 3, 2023 05:24
@BPScott
Copy link
Copy Markdown
Member Author

BPScott commented Dec 3, 2023 •
edited
Loading

There we go, I believe that's the markdown stuff put back properly. That last rebase was tidying up the wording of the global ignores block at the bottom and some variable renaming. @JounQin I've tagged you for one last re-review if you'd be so kind.

BPScott
BPScott commented Dec 3, 2023
View reviewed changes
Comment thread eslint.config.js
@BPScott BPScott merged commit 78c8b80 into master Dec 3, 2023
@BPScott BPScott deleted the localflatconfig branch December 3, 2023 06:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@JounQin JounQin JounQin approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@BPScott @JounQin