vue/define-emits-declaration 风格
它做了什么
此规则强制使用 defineEmits 的类型声明风格,你应该使用基于类型(type-based)、严格类型字面量(type-literal,Vue 3.3 引入)或运行时声明(runtime)的方式。
该规则仅在 setup 脚本中且 lang="ts" 时生效。
为什么这是个问题?
不一致的代码风格可能会造成混淆,使代码更难阅读。
示例
以下为错误的代码示例:
vue
// "vue/define-emits-declaration": ["error", "type-based"]
<script setup lang="ts">
const emit = defineEmits(["change", "update"]);
const emit2 = defineEmits({
change: (id) => typeof id === "number",
update: (value) => typeof value === "string",
});
</script>
// "vue/define-emits-declaration": ["error", "type-literal"]
<script setup lang="ts">
const emit = defineEmits<{
(e: "change", id: number): void;
(e: "update", value: string): void;
}>();
</script>
// "vue/define-emits-declaration": ["error", "runtime"]
<script setup lang="ts">
const emit = defineEmits<{
(e: "change", id: number): void;
(e: "update", value: string): void;
}>();
</script>以下为正确的代码示例:
vue
// "vue/define-emits-declaration": ["error", "type-based"]
<script setup lang="ts">
const emit = defineEmits<{
(e: "change", id: number): void;
(e: "update", value: string): void;
}>();
const emit2 = defineEmits<{
change: [id: number];
update: [value: string];
}>();
</script>
// "vue/define-emits-declaration": ["error", "type-literal"]
<script setup lang="ts">
const emit = defineEmits<{
change: [id: number];
update: [value: string];
}>();
</script>
// "vue/define-emits-declaration": ["error", "runtime"]
<script setup lang="ts">
const emit = defineEmits<{
(e: "change", id: number): void;
(e: "update", value: string): void;
}>();
const emit2 = defineEmits({
change: (id) => typeof id === "number",
update: (value) => typeof value === "string",
});
</script>配置
此规则接受以下字符串值之一:
"type-based"
强制使用命名的 TypeScript 类型或接口作为 defineEmits 的参数,例如:defineEmits<MyEmits>()。
"type-literal"
强制使用内联类型字面量作为 defineEmits 的参数,例如:defineEmits<{ (event: string): void }>()。
"runtime"
强制使用运行时声明方式,即通过数组或对象来声明 emits,例如:defineEmits(['event1', 'event2'])。
如何使用
要通过配置文件或 CLI 启用此规则,可以使用:
json
{
"plugins": ["vue"],
"rules": {
"vue/define-emits-declaration": "error"
}
}bash
oxlint --deny vue/define-emits-declaration --vue-plugin