feat(prefer-template-ref): support auto-fix

Author: 9romise

lib/rules/prefer-use-template-ref.js

@@ -43,6 +43,7 @@ module.exports = {
       categories: undefined,
       url: 'https://eslint.vuejs.org/rules/prefer-use-template-ref.html'
     },
+    fixable: 'code',
     schema: [],
     messages: {
       preferUseTemplateRef: "Replace '{{name}}' with 'useTemplateRef'."
@@ -98,6 +99,12 @@ module.exports = {
               data: {
                 // @ts-expect-error `scriptRef.callee` is `Identifier`
                 name: scriptRef.callee.name
+              },
+              fix(fixer) {
+                return fixer.replaceText(
+                  scriptRef,
+                  `useTemplateRef('${templateRef}')`
+                )
               }
             })
           }

tests/lib/rules/prefer-use-template-ref.js

@@ -311,14 +311,25 @@ tester.run('prefer-use-template-ref', rule, {
         const root = ref();
       </script>
       `,
+      output: `
+      <template>
+          <div ref="root"/>
+      </template>
+      <script setup>
+        import { ref } from 'vue';
+        const root = useTemplateRef('root');
+      </script>
+      `,
       errors: [
         {
           messageId: 'preferUseTemplateRef',
           data: {
             name: 'ref'
           },
           line: 7,
-          column: 22
+          column: 22,
+          endLine: 7,
+          endColumn: 27
         }
       ]
     },
@@ -335,14 +346,27 @@ tester.run('prefer-use-template-ref', rule, {
         const link = ref();
       </script>
       `,
+      output: `
+      <template>
+          <button ref="button">Content</button>
+          <a href="" ref="link">Link</a>
+      </template>
+      <script setup>
+        import { ref } from 'vue';
+        const buttonRef = ref();
+        const link = useTemplateRef('link');
+      </script>
+      `,
       errors: [
         {
           messageId: 'preferUseTemplateRef',
           data: {
             name: 'ref'
           },
           line: 9,
-          column: 22
+          column: 22,
+          endLine: 9,
+          endColumn: 27
         }
       ]
     },
@@ -359,22 +383,37 @@ tester.run('prefer-use-template-ref', rule, {
         const link = ref();
       </script>
       `,
+      output: `
+      <template>
+          <h1 ref="heading">Heading</h1>
+          <a href="" ref="link">Link</a>
+      </template>
+      <script setup>
+        import { ref } from 'vue';
+        const heading = useTemplateRef('heading');
+        const link = useTemplateRef('link');
+      </script>
+      `,
       errors: [
         {
           messageId: 'preferUseTemplateRef',
           data: {
             name: 'ref'
           },
           line: 8,
-          column: 25
+          column: 25,
+          endLine: 8,
+          endColumn: 30
         },
         {
           messageId: 'preferUseTemplateRef',
           data: {
             name: 'ref'
           },
           line: 9,
-          column: 22
+          column: 22,
+          endLine: 9,
+          endColumn: 27
         }
       ]
     },
@@ -396,14 +435,32 @@ tester.run('prefer-use-template-ref', rule, {
         }
       </script>
       `,
+      output: `
+      <template>
+        <p>Button clicked {{counter}} times.</p>
+        <button ref="button">Click</button>
+      </template>
+      <script>
+        import { ref } from 'vue';
+        export default {
+          name: 'Counter',
+          setup() {
+            const counter = ref(0);
+            const button = useTemplateRef('button');
+          }
+        }
+      </script>
+      `,
       errors: [
         {
           messageId: 'preferUseTemplateRef',
           data: {
             name: 'ref'
           },
           line: 12,
-          column: 28
+          column: 28,
+          endLine: 12,
+          endColumn: 33
         }
       ]
     },
@@ -418,14 +475,25 @@ tester.run('prefer-use-template-ref', rule, {
         const root = shallowRef();
       </script>
       `,
+      output: `
+      <template>
+          <div ref="root"/>
+      </template>
+      <script setup>
+        import { shallowRef } from 'vue';
+        const root = useTemplateRef('root');
+      </script>
+      `,
       errors: [
         {
           messageId: 'preferUseTemplateRef',
           data: {
             name: 'shallowRef'
           },
           line: 7,
-          column: 22
+          column: 22,
+          endLine: 7,
+          endColumn: 34
         }
       ]
     },
@@ -444,14 +512,29 @@ tester.run('prefer-use-template-ref', rule, {
         }
       </script>
       `,
+      output: `
+      <template>
+        <button ref="button">Click</button>
+      </template>
+      <script>
+        import { ref } from 'vue';
+        export default {
+          setup: () => {
+            const button = useTemplateRef('button');
+          }
+        }
+      </script>
+      `,
       errors: [
         {
           messageId: 'preferUseTemplateRef',
           data: {
             name: 'ref'
           },
           line: 9,
-          column: 28
+          column: 28,
+          endLine: 9,
+          endColumn: 33
         }
       ]
     },
@@ -467,6 +550,20 @@ tester.run('prefer-use-template-ref', rule, {
       const root = ref()
       </script>
 
+      <script>
+      const A = 'foo'
+      </script>
+      `,
+      output: `
+      <template>
+        <div ref="root" :data-a="A" />
+      </template>
+
+      <script setup>
+      import { ref } from 'vue'
+      const root = useTemplateRef('root')
+      </script>
+
       <script>
       const A = 'foo'
       </script>
@@ -478,7 +575,9 @@ tester.run('prefer-use-template-ref', rule, {
             name: 'ref'
           },
           line: 8,
-          column: 20
+          column: 20,
+          endLine: 8,
+          endColumn: 25
         }
       ]
     },
@@ -498,14 +597,30 @@ tester.run('prefer-use-template-ref', rule, {
       const root = ref()
       </script>
       `,
+      output: `
+      <template>
+        <div ref="root" :data-a="A" />
+      </template>
+
+      <script>
+      const A = 'foo'
+      </script>
+
+      <script setup>
+      import { ref } from 'vue'
+      const root = useTemplateRef('root')
+      </script>
+      `,
       errors: [
         {
           messageId: 'preferUseTemplateRef',
           data: {
             name: 'ref'
           },
           line: 12,
-          column: 20
+          column: 20,
+          endLine: 12,
+          endColumn: 25
         }
       ]
     }