vue/no-deprecated-model-definition Correctness

🚧 An auto-fix is planned for this rule, but not implemented at this time.

What it does

Disallow deprecated model definition (in Vue.js 3.0.0+).

Why is this bad?

Vue 3 removed the per-component model option. Instead, v-model works through the modelValue prop and the update:modelValue event, so a model: { prop, event } block is no longer needed.

With { "allowVue3Compat": true }, a model block is allowed if it already uses the Vue 3-compatible modelValue / update:modelValue (or kebab-case model-value / update:model-value) pair, easing migration.

Examples

Examples of incorrect code for this rule:

vue

<script>
export default {
  model: {
    prop: "foo",
    event: "update",
  },
};
</script>

Examples of correct code for this rule with the { "allowVue3Compat": true } option:

vue

<script>
export default {
  model: {
    prop: "modelValue",
    event: "update:modelValue",
  },
};
</script>

Configuration

allowVue3Compat

type: boolean

default: false

Allow model: { prop: 'modelValue', event: 'update:modelValue' } (or the kebab-case model-value variant) which is forwards-compatible with Vue 3's v-model.

How to use

To enable this rule using the config file or in the CLI, you can use:

Config (.oxlintrc.json)Config (oxlint.config.ts)CLI

json

{
  "plugins": ["vue"],
  "rules": {
    "vue/no-deprecated-model-definition": "error"
  }
}

import { defineConfig } from "oxlint";

export default defineConfig({
  plugins: ["vue"],
  rules: {
    "vue/no-deprecated-model-definition": "error",
  },
});

bash

oxlint --deny vue/no-deprecated-model-definition --vue-plugin

Version

This rule was added in v1.63.0.

What it does ​

Why is this bad? ​

Examples ​

Configuration ​

allowVue3Compat ​

How to use ​

Version ​

References ​