script/require-explicit-emits
Require emitted events to be declared in defineEmits or the emits option.
| Default severity | Presets | Automatic fix | Options |
|---|---|---|---|
warning |
happy-path, ecosystem, nuxt, opinionated |
No | None |
Applies to: JS/TS scripts in Vue SFCs; examples show the relevant Options API or script setup form.
Bad
The captured emit function emits save, but defineEmits([]) declares no such event.
<script setup lang="ts">
const emit = defineEmits([]);
emit("save");
</script>
Good
Adding "save" to the declaration makes the emitted literal event part of the component’s explicit event contract.
<script setup lang="ts">
const emit = defineEmits(["save"]);
emit("save");
</script>
Configuration (Vite+)
import { defineConfig } from "@vizejs/vite-plugin/vite-plus";
export default defineConfig({}).withVue({
linter: {
"preset": "incremental",
"rules": {
"script/require-explicit-emits": "warn"
}
},
});
Then run vp run lint.