feat(eslint-plugin): [switch-exhaustiveness-check] add support for "no default" comment #10218
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for the PR, @developer-bandi! typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community. The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately. Thanks again! 🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. |
✅ Deploy Preview for typescript-eslint ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #10218 +/- ##
=======================================
Coverage 86.77% 86.78%
=======================================
Files 444 444
Lines 15320 15328 +8
Branches 4461 4465 +4
=======================================
+ Hits 13294 13302 +8
Misses 1672 1672
Partials 354 354
Flags with carried forward coverage won't be shown. Click here to find out more.
|
yeonjuan
reviewed
Oct 28, 2024
packages/eslint-plugin/src/rules/switch-exhaustiveness-check.ts
Outdated
Show resolved
Hide resolved
|
I will resolve the conflict by merging the changes to the considerDefaultExhaustiveForUnions option currently reflected in the main branch and request a review again. |
…eslint into feature/switch-exhaustiveness-check-nodefaultcomment
JoshuaKGoldberg
requested changes
Nov 4, 2024
packages/eslint-plugin/src/rules/switch-exhaustiveness-check.ts
Outdated
Show resolved
Hide resolved
packages/eslint-plugin/src/rules/switch-exhaustiveness-check.ts
Outdated
Show resolved
Hide resolved
packages/eslint-plugin/src/rules/switch-exhaustiveness-check.ts
Outdated
Show resolved
Hide resolved
JoshuaKGoldberg
requested changes
Nov 10, 2024
packages/eslint-plugin/src/rules/switch-exhaustiveness-check.ts
Outdated
Show resolved
Hide resolved
packages/eslint-plugin/src/rules/switch-exhaustiveness-check.ts
Outdated
Show resolved
Hide resolved
packages/eslint-plugin/tests/rules/switch-exhaustiveness-check.test.ts
Outdated
Show resolved
Hide resolved
JoshuaKGoldberg
requested changes
Nov 22, 2024
packages/eslint-plugin/docs/rules/switch-exhaustiveness-check.mdx
Outdated
Show resolved
Hide resolved
packages/eslint-plugin/docs/rules/switch-exhaustiveness-check.mdx
Outdated
Show resolved
Hide resolved
packages/eslint-plugin/docs/rules/switch-exhaustiveness-check.mdx
Outdated
Show resolved
Hide resolved
packages/eslint-plugin/docs/rules/switch-exhaustiveness-check.mdx
Outdated
Show resolved
Hide resolved
packages/eslint-plugin/src/rules/switch-exhaustiveness-check.ts
Outdated
Show resolved
Hide resolved
…eslint into feature/switch-exhaustiveness-check-nodefaultcomment
6e0b96c to
e8ed38f
Compare
FloEdelmann
reviewed
Dec 4, 2024
| @@ -14,9 +14,11 @@ import { | |||
| requiresQuoting, | |||
| } from '../util'; | |||
|
|
|||
| const DEFAULT_COMMENT_PATTERN = /^no default$/iu; | |||
There was a problem hiding this comment.
If there's a default value, please specify it in defaultOptions.
There was a problem hiding this comment.
�In order to put a default value in defaultOptions, the defaultCaseCommentPattern option must be able to receive a flag. Therefore, this option should be in the form of an array, with an expression at the first index and a flag at the second index.
defaultCaseCommentPattern:["no default", "iu"]
Previously, the default value was treated as a separate variable because of equivalence with eslint rules. Would there be any problem with implementing it like this?
There was a problem hiding this comment.
As much as I would love to keep things to the defaultOptions plumbing, I don't think this is doable. I think this PR is fine as-is.
4 tasks
JoshuaKGoldberg
previously approved these changes
Dec 7, 2024
packages/eslint-plugin/docs/rules/switch-exhaustiveness-check.mdx
Outdated
Show resolved
Hide resolved
47f1ab3
into
typescript-eslint:main
56 of 58 checks passed
renovate bot
added a commit
to mmkal/eslint-plugin-mmkal
that referenced
this pull request
Dec 9, 2024
##### [v8.18.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8180-2024-12-09) ##### 🚀 Features - **eslint-plugin:** \[switch-exhaustiveness-check] add support for "no default" comment ([#10218](typescript-eslint/typescript-eslint#10218)) - **eslint-plugin:** \[no-deprecated] report on super call of deprecated constructor ([#10397](typescript-eslint/typescript-eslint#10397)) ##### 🩹 Fixes - **eslint-plugin:** \[use-unknown-in-catch-callback-variable] only flag function literals ([#10436](typescript-eslint/typescript-eslint#10436)) - **eslint-plugin:** \[no-base-to-string] handle more robustly when multiple `toString()` declarations are present for a type ([#10432](typescript-eslint/typescript-eslint#10432)) - **eslint-plugin:** \[no-deprecated] check if a JSX attribute is deprecated ([#10374](typescript-eslint/typescript-eslint#10374)) - typescript peer dependency ([#10373](typescript-eslint/typescript-eslint#10373)) ##### ❤️ Thank You - Kim Sang Du [@developer-bandi](https://github.com/developer-bandi) - Kirk Waiblinger [@kirkwaiblinger](https://github.com/kirkwaiblinger) - mdm317 - rtritto You can read about our [versioning strategy](https://main--typescript-eslint.netlify.app/users/versioning) and [releases](https://main--typescript-eslint.netlify.app/users/releases) on our website.
renovate bot
added a commit
to andrei-picus-tink/auto-renovate
that referenced
this pull request
Dec 10, 2024
| datasource | package | from | to | | ---------- | -------------------------------- | ------ | ------ | | npm | @typescript-eslint/eslint-plugin | 8.17.0 | 8.18.0 | | npm | @typescript-eslint/parser | 8.17.0 | 8.18.0 | ## [v8.18.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8180-2024-12-09) ##### 🚀 Features - **eslint-plugin:** \[switch-exhaustiveness-check] add support for "no default" comment ([#10218](typescript-eslint/typescript-eslint#10218)) - **eslint-plugin:** \[no-deprecated] report on super call of deprecated constructor ([#10397](typescript-eslint/typescript-eslint#10397)) ##### 🩹 Fixes - **eslint-plugin:** \[use-unknown-in-catch-callback-variable] only flag function literals ([#10436](typescript-eslint/typescript-eslint#10436)) - **eslint-plugin:** \[no-base-to-string] handle more robustly when multiple `toString()` declarations are present for a type ([#10432](typescript-eslint/typescript-eslint#10432)) - **eslint-plugin:** \[no-deprecated] check if a JSX attribute is deprecated ([#10374](typescript-eslint/typescript-eslint#10374)) - typescript peer dependency ([#10373](typescript-eslint/typescript-eslint#10373)) ##### ❤️ Thank You - Kim Sang Du [@developer-bandi](https://github.com/developer-bandi) - Kirk Waiblinger [@kirkwaiblinger](https://github.com/kirkwaiblinger) - mdm317 - rtritto You can read about our [versioning strategy](https://main--typescript-eslint.netlify.app/users/versioning) and [releases](https://main--typescript-eslint.netlify.app/users/releases) on our website.
renovate bot
added a commit
to andrei-picus-tink/auto-renovate
that referenced
this pull request
Dec 10, 2024
| datasource | package | from | to | | ---------- | -------------------------------- | ------ | ------ | | npm | @typescript-eslint/eslint-plugin | 8.17.0 | 8.18.0 | | npm | @typescript-eslint/parser | 8.17.0 | 8.18.0 | ## [v8.18.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8180-2024-12-09) ##### 🚀 Features - **eslint-plugin:** \[switch-exhaustiveness-check] add support for "no default" comment ([#10218](typescript-eslint/typescript-eslint#10218)) - **eslint-plugin:** \[no-deprecated] report on super call of deprecated constructor ([#10397](typescript-eslint/typescript-eslint#10397)) ##### 🩹 Fixes - **eslint-plugin:** \[use-unknown-in-catch-callback-variable] only flag function literals ([#10436](typescript-eslint/typescript-eslint#10436)) - **eslint-plugin:** \[no-base-to-string] handle more robustly when multiple `toString()` declarations are present for a type ([#10432](typescript-eslint/typescript-eslint#10432)) - **eslint-plugin:** \[no-deprecated] check if a JSX attribute is deprecated ([#10374](typescript-eslint/typescript-eslint#10374)) - typescript peer dependency ([#10373](typescript-eslint/typescript-eslint#10373)) ##### ❤️ Thank You - Kim Sang Du [@developer-bandi](https://github.com/developer-bandi) - Kirk Waiblinger [@kirkwaiblinger](https://github.com/kirkwaiblinger) - mdm317 - rtritto You can read about our [versioning strategy](https://main--typescript-eslint.netlify.app/users/versioning) and [releases](https://main--typescript-eslint.netlify.app/users/releases) on our website.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Checklist
Overview
similar to eslint's default-case rule, i modified to have the same effect as writing a default clause by specifying the
no defaultcomment. In the allowDefaultCaseForExhaustiveSwitch option, if no default is specified, an error may occur in the annotation in some cases, so it is necessary to review whether it is okay.one additional work is left The option considerDefaultExhaustiveForUnions in PR #9954 is in preparation for merging, so you will need to write a test case for that option once this PR is merged.