Skip to content

fix(eslint-plugin): [switch-exhaustiveness-check] add support for covering a missing property with undefined #10232

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Nov 4, 2024
Merged

fix(eslint-plugin): [switch-exhaustiveness-check] add support for covering a missing property with undefined #10232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
141eb59
don't report on the 'missing' undefined type if it's covered with an …
ronami Oct 29, 2024
f7ab3c4
projectService: false
ronami Oct 29, 2024
e52e44c
projectService: false on valid test too
ronami Oct 29, 2024
674c158
Update packages/eslint-plugin/src/rules/switch-exhaustiveness-check.ts
ronami Oct 30, 2024
64a712c
add relevant test
ronami Oct 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions packages/eslint-plugin/src/rules/switch-exhaustiveness-check.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,15 @@ export default createRule<Options, MessageIds>({
continue;
}

// "missing", "optional" and "undefined" types are different runtime objects,
// but all of them have TypeFlags.Undefined type flag
if (
[...caseTypes].some(tsutils.isIntrinsicUndefinedType) &&
tsutils.isIntrinsicUndefinedType(intersectionPart)
) {
continue;
}

missingLiteralBranchTypes.push(intersectionPart);
}
}
Expand Down
80 changes: 80 additions & 0 deletions packages/eslint-plugin/tests/rules/switch-exhaustiveness-check.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -912,6 +912,48 @@ switch (value) {
},
],
},
{
code: `
function foo(x: string[]) {
switch (x[0]) {
case 'hi':
break;
case undefined:
break;
}
}
`,
languageOptions: {
parserOptions: {
project: './tsconfig.noUncheckedIndexedAccess.json',
projectService: false,
tsconfigRootDir: rootPath,
},
},
},
{
code: `
function foo(x: string[], y: string | undefined) {
const a = x[0];
if (typeof a === 'string') {
return;
}
switch (y) {
case 'hi':
break;
case a:
break;
}
}
`,
languageOptions: {
parserOptions: {
project: './tsconfig.noUncheckedIndexedAccess.json',
projectService: false,
tsconfigRootDir: rootPath,
},
},
},
],
invalid: [
{
Expand Down Expand Up @@ -2717,5 +2759,43 @@ switch (value) {
},
],
},
{
code: `
function foo(x: string[]) {
switch (x[0]) {
case 'hi':
break;
}
}
`,
errors: [
{
column: 11,
line: 3,
messageId: 'switchIsNotExhaustive',
suggestions: [
{
messageId: 'addMissingCases',
output: `
function foo(x: string[]) {
switch (x[0]) {
case 'hi':
break;
case undefined: { throw new Error('Not implemented yet: undefined case') }
}
}
`,
},
],
},
],
languageOptions: {
parserOptions: {
project: './tsconfig.noUncheckedIndexedAccess.json',
projectService: false,
tsconfigRootDir: rootPath,
},
},
},
],
});
Loading