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

chore: switch to eslint flat config #60

Merged
merged 4 commits into from Feb 20, 2024
Merged

chore: switch to eslint flat config #60

merged 4 commits into from Feb 20, 2024

Conversation

mdjermanovic
Copy link
Member

Switches to flat config for linting this project.

lib/index.js Outdated
@@ -24,6 +24,8 @@ function filterKey(key) {
return !KEY_BLACKLIST.has(key) && key[0] !== "_";
}


/* eslint-disable jsdoc/valid-types -- doesn't allow `readonly`. TODO: check why */
Copy link
Member Author

Choose a reason for hiding this comment

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

For some reason, readonly string[] is considered invalid by jsdoc/valid-types. I disabled the rule here until we figure out what's the problem because changing this type would affect the types this package publishes.

Copy link
Member

Choose a reason for hiding this comment

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

Maybe worth opening an issue on the plugin?

Copy link
Member Author

Choose a reason for hiding this comment

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

Good idea. The issue template suggested opening an issue on the parser, here it is:

jsdoc-type-pratt-parser/jsdoc-type-pratt-parser#164

Copy link
Member Author

Choose a reason for hiding this comment

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

It seems like jsdoc-type-pratt-parser/jsdoc-type-pratt-parser#164 won't be fixed anytime soon since there's still no response.

@@ -1,6 +1,8 @@
/* eslint-disable jsdoc/valid-types -- doesn't allow `readonly`. TODO: check why */
Copy link
Member Author

Choose a reason for hiding this comment

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

Copy link
Member

@nzakas nzakas left a comment

Choose a reason for hiding this comment

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

LGTM.

@nzakas nzakas merged commit f988b6e into main Feb 20, 2024
8 checks passed
@nzakas nzakas deleted the flat-eslint branch February 20, 2024 23:58
@github-actions github-actions bot mentioned this pull request Feb 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Complete
Development

Successfully merging this pull request may close these issues.

None yet

2 participants