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

Configure ESLint's own rules #1815

Merged
merged 3 commits into from
Dec 15, 2024
Merged

Configure ESLint's own rules #1815

merged 3 commits into from
Dec 15, 2024

Conversation

ericcornelissen
Copy link
Owner

Relates to #1803, #1812

Summary

Update the ESLint config to enable and configure most of its own rules. This iteration on the configuration is mostly focused on enabling rules the code base already complies with or can trivially comply with to ensure consistency going forward. Any rule that has been disabled may be reconsidered in the future.

Update the ESLint config to enable and configure most of its own rules.
This iteration on the configuration is mostly focussed on enabling rules
the code base already complies with or can trivially comply with to
ensure consistency going forward. Any rule that has been disabled may be
reconsidered in the future.

Note that rules marked as "deprecated" by ESLint were not included here.
@ericcornelissen ericcornelissen added the meta Relates to the project or repository itself label Dec 15, 2024
@github-actions github-actions bot added the test Relates to testing label Dec 15, 2024
Comment on lines -38 to +42
"jsdoc/check-examples": ["off"], // TODO: enable & configure when possible
"jsdoc/check-examples": ["off"],
Copy link
Owner Author

Choose a reason for hiding this comment

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

Re-evaluating this TODO as part of this PR.

Copy link
Owner Author

Choose a reason for hiding this comment

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

The rule still does not work as of jsdoc/[email protected] so I'll leave it disabled.

I won't create an issue to enable this because I could not find a suitable way to track when this can be enabled again.

config/eslint.js Outdated Show resolved Hide resolved
@github-actions github-actions bot added the dependencies Changes to the project's dependencies label Dec 15, 2024
@ericcornelissen ericcornelissen removed the test Relates to testing label Dec 15, 2024
@ericcornelissen ericcornelissen merged commit 90c1a5c into main Dec 15, 2024
35 checks passed
@ericcornelissen ericcornelissen deleted the lint-eslint branch December 15, 2024 17:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Changes to the project's dependencies meta Relates to the project or repository itself
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant