typescript/switch-exhaustiveness-check Pedantic
作用
此规则要求在对联合类型进行 switch 判断时，switch 语句必须穷尽所有分支。
为什么这不好？
当对联合类型进行 switch 判断时，处理所有可能的情况非常重要，以避免运行时错误。TypeScript 可以帮助确保穷尽性，但前提是 switch 语句结构正确，并带有一个可供 TypeScript 分析的 default 分支。
示例
此规则的错误代码示例：
type Status = "pending" | "approved" | "rejected";
function handleStatus(status: Status) {
switch (status) {
case "pending":
return "等待审批";
case "approved":
return "请求已批准";
// 缺少 'rejected' 分支
}
}
enum Color {
Red,
Green,
Blue,
}
function getColorName(color: Color) {
switch (color) {
case Color.Red:
return "红色";
case Color.Green:
return "绿色";
// 缺少 Color.Blue 分支
}
}此规则的正确代码示例：
type Status = "pending" | "approved" | "rejected";
function handleStatus(status: Status) {
switch (status) {
case "pending":
return "等待审批";
case "approved":
return "请求已批准";
case "rejected":
return "请求已拒绝";
}
}
// 或者使用 default 分支进行穷尽性检查
function handleStatusWithDefault(status: Status) {
switch (status) {
case "pending":
return "等待审批";
case "approved":
return "请求已批准";
case "rejected":
return "请求已拒绝";
default:
const _exhaustiveCheck: never = status;
return _exhaustiveCheck;
}
}
enum Color {
Red,
Green,
Blue,
}
function getColorName(color: Color) {
switch (color) {
case Color.Red:
return "红色";
case Color.Green:
return "绿色";
case Color.Blue:
return "蓝色";
default:
const _exhaustiveCheck: never = color;
return _exhaustiveCheck;
}
}配置
此规则接受一个包含以下属性的配置对象：
allowDefaultCaseForExhaustiveSwitch
type: boolean
default: true
是否允许在非穷尽的 switch 中使用 default 分支。 当为 false 时，要求 switch 语句必须穷尽所有分支且不能有 default 分支。
considerDefaultExhaustiveForUnions
type: boolean
default: false
是否将 default 分支视为联合类型的穷尽分支。 当为 true 时，带有 default 分支的 switch 语句会被视为穷尽， 即使并未显式处理所有联合成员。
defaultCaseCommentPattern
type: string
将注释视为省略的 default 分支时使用的正则表达式模式。 注释必须出现在最后一个 case 之后，并且 switch 不能包含 default 分支。 对于联合类型，只有启用 considerDefaultExhaustiveForUnions 时，它才会抑制穷举检查。 示例："^skip default$" 允许以 // skip default 结尾的 switch。
requireDefaultForNonUnion
type: boolean
default: false
是否要求对非穷尽的联合类型 switch 使用 default 分支。 当为 true 时，针对非穷尽联合类型的 switch 必须包含 default 分支。
如何使用
To enable this rule using the config file or in the CLI, you can use:
{
"options": {
"typeAware": true
},
"rules": {
"typescript/switch-exhaustiveness-check": "error"
}
}import { defineConfig } from "oxlint";
export default defineConfig({
options: { typeAware: true },
rules: {
"typescript/switch-exhaustiveness-check": "error",
},
});oxlint --type-aware --deny typescript/switch-exhaustiveness-check版本
此规则在 v1.12.0 中添加。