feat(no-unused-refs): support template ref api (#2541)

Co-authored-by: Flo Edelmann <[email protected]>
vuejs · Sep 12, 2024 · c27837d · c27837d
1 parent dfdbe1a
commit c27837d
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/lib/rules/no-unused-refs.js b/lib/rules/no-unused-refs.js
@@ -233,6 +233,19 @@ module.exports = {
               refsNode = id.parent
             }
             extractUsedForPattern(refsNode)
+          },
+          CallExpression(callExpression) {
+            const firstArgument = callExpression.arguments[0]
+            if (
+              callExpression.callee.name !== 'useTemplateRef' ||
+              !firstArgument
+            ) {
+              return
+            }
+            const name = utils.getStringLiteralValue(firstArgument)
+            if (name !== null) {
+              usedRefs.add(name)
+            }
           }
         }
       )

diff --git a/tests/lib/rules/no-unused-refs.js b/tests/lib/rules/no-unused-refs.js
@@ -315,6 +315,20 @@ tester.run('no-unused-refs', rule, {
       const x = ref(null)
       </script>
       `
+    },
+    {
+      filename: 'test.vue',
+      code: `
+      <template>
+        <input ref="x" />
+        <input ref="y" />
+      </template>
+      <script setup>
+      import {useTemplateRef} from 'vue'
+      const inputX = useTemplateRef('x')
+      const inputY = useTemplateRef(\`y\`)
+      </script>
+      `
     }
   ],