Remove Deprecated ESLint Config #2504
Conversation
WalkthroughThe changes involve updating the ESLint configuration to remove deprecated rules and introduce new ones that enhance type safety in TypeScript. Specifically, the deprecated Changes
Assessment against linked issues
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
Early access features: disabledWe are currently testing the following features in early access:
Note:
|
Our Pull Request Approval ProcessWe have these basic policies to make the approval process smoother for our volunteer team. Testing Your CodePlease make sure your code passes all tests. Our test code coverage system will fail if these conditions occur:
The process helps maintain the overall reliability of the code base and is a prerequisite for getting your PR approved. Assigned reviewers regularly review the PR queue and tend to focus on PRs that are passing. ReviewersDo not assign reviewers. Our Queue Monitors will review your PR and assign them.
Reviewing Your CodeYour reviewer(s) will have the following roles:
CONTRIBUTING.mdRead our CONTRIBUTING.md file. Most importantly:
Other
|
|
@palisadoes @tasneemkoushar Pls review and merge as its a blocker for raising any other PRs in API |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (2)
- .eslintrc.json (2 hunks)
- README.md (1 hunks)
Files skipped from review due to trivial changes (1)
- README.md
Additional comments not posted (4)
.eslintrc.json (4)
113-115: LGTM: Removal of deprecated rule.The removal of the deprecated
@typescript-eslint/ban-typesrule is necessary to align with the latest TypeScript ESLint version. The PR summary and linked issue provide sufficient context for this change.
113-113: LGTM: Addition of new rule to enhance type safety.The addition of the
@typescript-eslint/no-unsafe-function-typerule is a suitable replacement for the deprecated@typescript-eslint/ban-typesrule. It enhances type safety by prohibiting the use of the built-inFunctiontype, aligning with the objective of improving code quality and maintainability.
114-114: LGTM: Addition of new rule to enhance type safety.The addition of the
@typescript-eslint/no-wrapper-object-typesrule is a suitable replacement for the deprecated@typescript-eslint/ban-typesrule. It enhances type safety by banning the use of built-in class wrappers likeNumber, aligning with the objective of improving code quality and maintainability.
115-115: LGTM: Addition of new rule to enhance type safety.The addition of the
@typescript-eslint/no-empty-object-typerule is a suitable replacement for the deprecated@typescript-eslint/ban-typesrule. It enhances type safety by banning the use of the built-in{}type in potentially confusing contexts, aligning with the objective of improving code quality and maintainability.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #2504 +/- ##
========================================
Coverage 98.90% 98.90%
========================================
Files 357 357
Lines 18013 18013
Branches 2400 2400
========================================
Hits 17815 17815
Misses 195 195
Partials 3 3 ☔ View full report in Codecov by Sentry. |
palisadoes
merged commit 95597d7
into
PalisadoesFoundation:develop
* remove deprecated ban-types * remove auto readme changes * revert readme
What kind of change does this PR introduce?
bugfix
Issue Number:
Fixes #2496
Did you add tests for your changes?
Yes
Summary
Suggested by typescript-eslint docs
Removed:
@typescript-eslint/ban-types: This rule has been deprecated and removed in TypeScript ESLint v8.
Added:
@typescript-eslint/no-empty-object-type: Enforces banning the built-in {} type in confusing locations.
@typescript-eslint/no-unsafe-function-type: Enforces banning the built-in Function type.
@typescript-eslint/no-wrapper-object-types: Enforces banning built-in class wrappers such as Number.
Does this PR introduce a breaking change?
No
Have you read the contributing guide?
Yes
Summary by CodeRabbit