From f9e0bd267880bfb0ffdbde61166489d989282a35 Mon Sep 17 00:00:00 2001
From: Flo Edelmann <git@flo-edelmann.de>
Date: Mon, 17 Jul 2023 19:27:19 +0200
Subject: [PATCH 1/2] Add `vue/no-deprecated-model-definition` rule

---
 docs/rules/index.md                           |   1 +
 docs/rules/no-deprecated-model-definition.md  |  76 +++++++
 lib/index.js                                  |   1 +
 lib/rules/no-deprecated-model-definition.js   | 112 ++++++++++
 .../rules/no-deprecated-model-definition.js   | 205 ++++++++++++++++++
 5 files changed, 395 insertions(+)
 create mode 100644 docs/rules/no-deprecated-model-definition.md
 create mode 100644 lib/rules/no-deprecated-model-definition.js
 create mode 100644 tests/lib/rules/no-deprecated-model-definition.js

diff --git a/docs/rules/index.md b/docs/rules/index.md
index 1ef0ef39d..bd25f19d1 100644
--- a/docs/rules/index.md
+++ b/docs/rules/index.md
@@ -226,6 +226,7 @@ For example:
 | [vue/next-tick-style](./next-tick-style.md) | enforce Promise or callback style in `nextTick` | :wrench: | :hammer: |
 | [vue/no-bare-strings-in-template](./no-bare-strings-in-template.md) | disallow the use of bare strings in `<template>` |  | :hammer: |
 | [vue/no-boolean-default](./no-boolean-default.md) | disallow boolean defaults | :wrench: | :hammer: |
+| [vue/no-deprecated-model-definition](./no-deprecated-model-definition.md) | disallow deprecated `model` definition (in Vue.js 3.0.0+) | :bulb: | :warning: |
 | [vue/no-duplicate-attr-inheritance](./no-duplicate-attr-inheritance.md) | enforce `inheritAttrs` to be set to `false` when using `v-bind="$attrs"` |  | :hammer: |
 | [vue/no-empty-component-block](./no-empty-component-block.md) | disallow the `<template>` `<script>` `<style>` block to be empty |  | :hammer: |
 | [vue/no-multiple-objects-in-class](./no-multiple-objects-in-class.md) | disallow to pass multiple objects into array to class |  | :hammer: |
diff --git a/docs/rules/no-deprecated-model-definition.md b/docs/rules/no-deprecated-model-definition.md
new file mode 100644
index 000000000..bb2777d69
--- /dev/null
+++ b/docs/rules/no-deprecated-model-definition.md
@@ -0,0 +1,76 @@
+---
+pageClass: rule-details
+sidebarDepth: 0
+title: vue/no-deprecated-model-definition
+description: disallow deprecated `model` definition (in Vue.js 3.0.0+)
+---
+# vue/no-deprecated-model-definition
+
+> disallow deprecated `model` definition (in Vue.js 3.0.0+)
+
+- :exclamation: <badge text="This rule has not been released yet." vertical="middle" type="error"> ***This rule has not been released yet.*** </badge>
+- :bulb: Some problems reported by this rule are manually fixable by editor [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
+
+## :book: Rule Details
+
+This rule reports use of the component `model` option, which has been deprecated in Vue.js 3.0.0+.
+
+See [Migration Guide – `v-model`](https://v3-migration.vuejs.org/breaking-changes/v-model.html) for more details.
+
+<eslint-code-block :rules="{'vue/no-deprecated-model-definition': ['error']}">
+
+```vue
+<script>
+export default defineComponent({
+  model: {
+    prop: 'my-value',
+    event: 'input'
+  }
+})
+</script>
+```
+
+</eslint-code-block>
+
+## :wrench: Options
+
+```json
+{
+  "vue/no-deprecated-model-definition": ["error", {
+    "allowVue3Compat": true
+  }]
+}
+```
+
+### `"allowVue3Compat": true`
+
+Allow `model` definitions with prop/event names that match the Vue.js 3.0.0+ `v-model` syntax, e.g. `fooBar`/`update:fooBar`.
+
+<eslint-code-block :rules="{'vue/no-deprecated-model-definition': ['error', { allowVue3Compat: true }]}">
+
+```vue
+<script>
+export default defineComponent({
+  model: {
+    prop: 'fooBar',
+    event: 'update:fooBar'
+  }
+})
+</script>
+```
+
+</eslint-code-block>
+
+## :couple: Related Rules
+
+- [vue/valid-model-definition](./valid-model-definition.md) (for Vue.js 2.x)
+- [vue/no-v-model-argument](./no-v-model-argument.md) (for Vue.js 2.x)
+
+## :books: Further Reading
+
+- [Migration Guide – `v-model`](https://v3-migration.vuejs.org/breaking-changes/v-model.html)
+
+## :mag: Implementation
+
+- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/no-deprecated-model-definition.js)
+- [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/no-deprecated-model-definition.js)
diff --git a/lib/index.js b/lib/index.js
index 6c52515a8..d3bdc3a83 100644
--- a/lib/index.js
+++ b/lib/index.js
@@ -79,6 +79,7 @@ module.exports = {
     'no-deprecated-functional-template': require('./rules/no-deprecated-functional-template'),
     'no-deprecated-html-element-is': require('./rules/no-deprecated-html-element-is'),
     'no-deprecated-inline-template': require('./rules/no-deprecated-inline-template'),
+    'no-deprecated-model-definition': require('./rules/no-deprecated-model-definition'),
     'no-deprecated-props-default-this': require('./rules/no-deprecated-props-default-this'),
     'no-deprecated-router-link-tag-prop': require('./rules/no-deprecated-router-link-tag-prop'),
     'no-deprecated-scope-attribute': require('./rules/no-deprecated-scope-attribute'),
diff --git a/lib/rules/no-deprecated-model-definition.js b/lib/rules/no-deprecated-model-definition.js
new file mode 100644
index 000000000..f1561c202
--- /dev/null
+++ b/lib/rules/no-deprecated-model-definition.js
@@ -0,0 +1,112 @@
+/**
+ * @author Flo Edelmann
+ * See LICENSE file in root directory for full license.
+ */
+'use strict'
+
+const utils = require('../utils')
+
+/**
+ * @param {RuleContext} context
+ * @param {ASTNode} node
+ */
+function reportWithoutSuggestion(context, node) {
+  context.report({
+    node,
+    messageId: 'deprecatedModel'
+  })
+}
+
+/**
+ * @param {ObjectExpression} node
+ * @param {string} key
+ * @returns {Literal | undefined}
+ */
+function findPropertyValue(node, key) {
+  const property = node.properties.find(
+    (property) =>
+      property.type === 'Property' &&
+      property.key.type === 'Identifier' &&
+      property.key.name === key
+  )
+  if (
+    !property ||
+    property.type !== 'Property' ||
+    property.value.type !== 'Literal'
+  ) {
+    return undefined
+  }
+  return property.value
+}
+
+module.exports = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description: 'disallow deprecated `model` definition (in Vue.js 3.0.0+)',
+      categories: undefined,
+      url: 'https://eslint.vuejs.org/rules/no-deprecated-model-definition.html'
+    },
+    fixable: null,
+    hasSuggestions: true,
+    schema: [
+      {
+        type: 'object',
+        additionalProperties: false,
+        properties: {
+          allowVue3Compat: {
+            type: 'boolean'
+          }
+        }
+      }
+    ],
+    messages: {
+      deprecatedModel: '`model` definition is deprecated.',
+      renameEvent: 'Rename event to `{{expectedEventName}}`.'
+    }
+  },
+  /** @param {RuleContext} context */
+  create(context) {
+    const allowVue3Compat = Boolean(context.options[0]?.allowVue3Compat)
+
+    return utils.executeOnVue(context, (obj) => {
+      const modelProperty = utils.findProperty(obj, 'model')
+      if (!modelProperty || modelProperty.value.type !== 'ObjectExpression') {
+        return
+      }
+
+      if (!allowVue3Compat) {
+        reportWithoutSuggestion(context, modelProperty)
+        return
+      }
+
+      const propName = findPropertyValue(modelProperty.value, 'prop')
+      const eventName = findPropertyValue(modelProperty.value, 'event')
+
+      if (!propName || !eventName) {
+        reportWithoutSuggestion(context, modelProperty)
+        return
+      }
+
+      const expectedEventName = `update:${propName.value}`
+      if (eventName.value !== expectedEventName) {
+        context.report({
+          node: modelProperty,
+          messageId: 'deprecatedModel',
+          suggest: [
+            {
+              messageId: 'renameEvent',
+              data: { expectedEventName },
+              fix(fixer) {
+                return fixer.replaceTextRange(
+                  [eventName.range[0] + 1, eventName.range[1] - 1],
+                  expectedEventName
+                )
+              }
+            }
+          ]
+        })
+      }
+    })
+  }
+}
diff --git a/tests/lib/rules/no-deprecated-model-definition.js b/tests/lib/rules/no-deprecated-model-definition.js
new file mode 100644
index 000000000..844b2b06c
--- /dev/null
+++ b/tests/lib/rules/no-deprecated-model-definition.js
@@ -0,0 +1,205 @@
+/**
+ * @author Flo Edelmann
+ * See LICENSE file in root directory for full license.
+ */
+'use strict'
+
+const RuleTester = require('eslint').RuleTester
+const rule = require('../../../lib/rules/no-deprecated-model-definition')
+
+const tester = new RuleTester({
+  parser: require.resolve('vue-eslint-parser'),
+  parserOptions: {
+    ecmaVersion: 2020,
+    sourceType: 'module'
+  }
+})
+
+tester.run('no-deprecated-model-definition', rule, {
+  valid: [
+    {
+      filename: 'test.vue',
+      code: `
+        <script>
+        export default { name: 'test' }
+        </script>
+      `
+    },
+    {
+      filename: 'test.vue',
+      options: [{ allowVue3Compat: true }],
+      code: `
+        <script>
+        export default {
+          model: {
+            prop: 'fooBar',
+            event: 'update:fooBar'
+          }
+        }
+        </script>
+      `
+    },
+    {
+      filename: 'test.vue',
+      options: [{ allowVue3Compat: true }],
+      code: `
+        <script>
+        export default defineComponent({
+          model: {
+            prop: 'foo-bar',
+            event: 'update:foo-bar'
+          }
+        })
+        </script>
+      `
+    }
+  ],
+  invalid: [
+    {
+      filename: 'test.vue',
+      code: `
+        <script>
+        export default {
+          model: {
+            prop: 'foo',
+          }
+        }
+        </script>
+      `,
+      errors: [
+        {
+          message: '`model` definition is deprecated.',
+          line: 4,
+          column: 11,
+          endLine: 6,
+          endColumn: 12
+        }
+      ]
+    },
+    {
+      filename: 'test.vue',
+      code: `
+        <script>
+        export default Vue.extend({
+          model: {
+            event: 'update'
+          }
+        })
+        </script>
+      `,
+      errors: [
+        {
+          message: '`model` definition is deprecated.',
+          line: 4,
+          column: 11,
+          endLine: 6,
+          endColumn: 12
+        }
+      ]
+    },
+    {
+      filename: 'test.vue',
+      code: `
+        <script>
+        export default defineComponent({
+          model: {
+            prop: 'foo',
+            event: 'update'
+          }
+        })
+        </script>
+      `,
+      errors: [
+        {
+          message: '`model` definition is deprecated.',
+          line: 4,
+          column: 11,
+          endLine: 7,
+          endColumn: 12
+        }
+      ]
+    },
+    {
+      filename: 'test.vue',
+      options: [{ allowVue3Compat: true }],
+      code: `
+        <script>
+        export default {
+          model: {
+            prop: 'foo',
+          }
+        }
+        </script>
+      `,
+      errors: [
+        {
+          message: '`model` definition is deprecated.',
+          line: 4,
+          column: 11,
+          endLine: 6,
+          endColumn: 12
+        }
+      ]
+    },
+    {
+      filename: 'test.vue',
+      options: [{ allowVue3Compat: true }],
+      code: `
+        <script>
+        export default Vue.extend({
+          model: {
+            event: 'update'
+          }
+        })
+        </script>
+      `,
+      errors: [
+        {
+          message: '`model` definition is deprecated.',
+          line: 4,
+          column: 11,
+          endLine: 6,
+          endColumn: 12
+        }
+      ]
+    },
+    {
+      filename: 'test.vue',
+      options: [{ allowVue3Compat: true }],
+      code: `
+        <script>
+        export default defineComponent({
+          model: {
+            prop: 'foo',
+            event: 'update'
+          }
+        })
+        </script>
+      `,
+      errors: [
+        {
+          message: '`model` definition is deprecated.',
+          line: 4,
+          column: 11,
+          endLine: 7,
+          endColumn: 12,
+          suggestions: [
+            {
+              desc: 'Rename event to `update:foo`.',
+              output: `
+        <script>
+        export default defineComponent({
+          model: {
+            prop: 'foo',
+            event: 'update:foo'
+          }
+        })
+        </script>
+      `
+            }
+          ]
+        }
+      ]
+    }
+  ]
+})

From 4219e9cd10d8f88c236ee429c7c334610db151ec Mon Sep 17 00:00:00 2001
From: Flo Edelmann <git@flo-edelmann.de>
Date: Wed, 19 Jul 2023 09:17:41 +0200
Subject: [PATCH 2/2] Move options to canonical position

---
 tests/lib/rules/no-deprecated-model-definition.js | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/tests/lib/rules/no-deprecated-model-definition.js b/tests/lib/rules/no-deprecated-model-definition.js
index 844b2b06c..71adb34f5 100644
--- a/tests/lib/rules/no-deprecated-model-definition.js
+++ b/tests/lib/rules/no-deprecated-model-definition.js
@@ -27,7 +27,6 @@ tester.run('no-deprecated-model-definition', rule, {
     },
     {
       filename: 'test.vue',
-      options: [{ allowVue3Compat: true }],
       code: `
         <script>
         export default {
@@ -37,11 +36,11 @@ tester.run('no-deprecated-model-definition', rule, {
           }
         }
         </script>
-      `
+      `,
+      options: [{ allowVue3Compat: true }]
     },
     {
       filename: 'test.vue',
-      options: [{ allowVue3Compat: true }],
       code: `
         <script>
         export default defineComponent({
@@ -51,7 +50,8 @@ tester.run('no-deprecated-model-definition', rule, {
           }
         })
         </script>
-      `
+      `,
+      options: [{ allowVue3Compat: true }]
     }
   ],
   invalid: [
@@ -121,7 +121,6 @@ tester.run('no-deprecated-model-definition', rule, {
     },
     {
       filename: 'test.vue',
-      options: [{ allowVue3Compat: true }],
       code: `
         <script>
         export default {
@@ -131,6 +130,7 @@ tester.run('no-deprecated-model-definition', rule, {
         }
         </script>
       `,
+      options: [{ allowVue3Compat: true }],
       errors: [
         {
           message: '`model` definition is deprecated.',
@@ -143,7 +143,6 @@ tester.run('no-deprecated-model-definition', rule, {
     },
     {
       filename: 'test.vue',
-      options: [{ allowVue3Compat: true }],
       code: `
         <script>
         export default Vue.extend({
@@ -153,6 +152,7 @@ tester.run('no-deprecated-model-definition', rule, {
         })
         </script>
       `,
+      options: [{ allowVue3Compat: true }],
       errors: [
         {
           message: '`model` definition is deprecated.',
@@ -165,7 +165,6 @@ tester.run('no-deprecated-model-definition', rule, {
     },
     {
       filename: 'test.vue',
-      options: [{ allowVue3Compat: true }],
       code: `
         <script>
         export default defineComponent({
@@ -176,6 +175,7 @@ tester.run('no-deprecated-model-definition', rule, {
         })
         </script>
       `,
+      options: [{ allowVue3Compat: true }],
       errors: [
         {
           message: '`model` definition is deprecated.',