vue/valid-model-definition

Require valid keys in the model option.

Applies to: JS/TS scripts in Vue SFCs; examples show the relevant Options API or script setup form.

This opt-in rule checks Vue 2's model option. Only the static keys prop and event are accepted; their values are not validated. Vue 3 uses the newer component v-model contract instead of this option.

Bad

events is not a supported key in Vue 2's component model option.

<script lang="ts">
export default { model: { prop: "value", events: "input" } };
</script>

Good

Use the supported singular event key together with prop to describe the Vue 2 model contract.

<script lang="ts">
export default { model: { prop: "value", event: "input" } };
</script>

Configuration (Vite+)

import { defineConfig } from "@vizejs/vite-plugin/vite-plus";

export default defineConfig({}).withVue({
  linter: {
    "preset": "incremental",
    "rules": {
      "vue/valid-model-definition": "error"
    }
  },
});

Then run vp run lint.

Related

• Vue rules
• All rules
• Source code