-
Notifications
You must be signed in to change notification settings - Fork 8
Remove components eslint dependency #597
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
base: main
Are you sure you want to change the base?
Conversation
…ing them from npm
…omponents-eslint-dependency
WalkthroughThe ESLint configuration in packages/components is modernized from a project-specific setup to a comprehensive, plugin-rich configuration with support for TypeScript, React, and JSDoc. The related custom Maps Indoors ESLint config dependencies are removed from package.json and replaced with eslint-plugin-jsdoc. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes
Suggested labels
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
packages/components/.eslintrc.js (1)
74-74: Deprecated rule:@typescript-eslint/no-parameter-properties.This rule was deprecated in @typescript-eslint/eslint-plugin v5.46.0 and renamed to
@typescript-eslint/parameter-properties. Since you're using^5.45.1, newer patch versions may trigger a deprecation warning.- '@typescript-eslint/no-parameter-properties': 'off', + '@typescript-eslint/parameter-properties': 'off',
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (2)
packages/components/.eslintrc.js(1 hunks)packages/components/package.json(2 hunks)
🔇 Additional comments (3)
packages/components/.eslintrc.js (3)
40-41: LGTM!Disabling base ESLint
no-unused-varsandno-undefis the correct approach for TypeScript projects. The TypeScript-specific@typescript-eslint/no-unused-varsrule at line 78 properly handles unused variables, while the TypeScript compiler catches undefined references.
1-23: Well-structured ESLint configuration.The migration from project-specific
@mapsindoors/eslint-configto a standardeslint:recommendedbase with explicit plugins is a good approach for maintainability. The configuration properly sets up TypeScript parsing, JSX support, and the necessary plugins.
54-54: Remove deprecated rule:jsdoc/newline-after-description.This rule was removed in eslint-plugin-jsdoc and is no longer functional. The
jsdoc/tag-linesrule (line 71) handles the newline formatting it provided.- 'jsdoc/newline-after-description': 1,
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.