120 lines
3.0 KiB
JavaScript
120 lines
3.0 KiB
JavaScript
/**
|
|
* @author Thomasan1999
|
|
* See LICENSE file in root directory for full license.
|
|
*/
|
|
'use strict'
|
|
|
|
const utils = require('../utils')
|
|
|
|
/**
|
|
* @typedef ScriptRef
|
|
* @type {{node: Expression, ref: string}}
|
|
*/
|
|
|
|
/**
|
|
* @param declarator {VariableDeclarator}
|
|
* @returns {ScriptRef}
|
|
* */
|
|
function convertDeclaratorToScriptRef(declarator) {
|
|
return {
|
|
// @ts-ignore
|
|
node: declarator.init,
|
|
// @ts-ignore
|
|
ref: declarator.id.name
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param body {(Statement | ModuleDeclaration)[]}
|
|
* @returns {ScriptRef[]}
|
|
* */
|
|
function getScriptRefsFromSetupFunction(body) {
|
|
/** @type {VariableDeclaration[]} */
|
|
const variableDeclarations = body.filter(
|
|
(child) => child.type === 'VariableDeclaration'
|
|
)
|
|
const variableDeclarators = variableDeclarations.map(
|
|
(declaration) => declaration.declarations[0]
|
|
)
|
|
const refDeclarators = variableDeclarators.filter((declarator) =>
|
|
// @ts-ignore
|
|
['ref', 'shallowRef'].includes(declarator.init?.callee?.name)
|
|
)
|
|
|
|
return refDeclarators.map(convertDeclaratorToScriptRef)
|
|
}
|
|
|
|
/** @type {import("eslint").Rule.RuleModule} */
|
|
module.exports = {
|
|
meta: {
|
|
type: 'suggestion',
|
|
docs: {
|
|
description:
|
|
'require using `useTemplateRef` instead of `ref`/`shallowRef` for template refs',
|
|
categories: undefined,
|
|
url: 'https://eslint.vuejs.org/rules/prefer-use-template-ref.html'
|
|
},
|
|
schema: [],
|
|
messages: {
|
|
preferUseTemplateRef: "Replace '{{name}}' with 'useTemplateRef'."
|
|
}
|
|
},
|
|
/** @param {RuleContext} context */
|
|
create(context) {
|
|
/** @type Set<string> */
|
|
const templateRefs = new Set()
|
|
|
|
/**
|
|
* @type ScriptRef[] */
|
|
const scriptRefs = []
|
|
|
|
return utils.compositingVisitors(
|
|
utils.defineTemplateBodyVisitor(context, {
|
|
'VAttribute[directive=false]'(node) {
|
|
if (node.key.name === 'ref' && node.value?.value) {
|
|
templateRefs.add(node.value.value)
|
|
}
|
|
}
|
|
}),
|
|
utils.defineVueVisitor(context, {
|
|
onSetupFunctionEnter(node) {
|
|
if (node.type === 'ArrowFunctionExpression' && node.expression) {
|
|
return
|
|
}
|
|
const newScriptRefs = getScriptRefsFromSetupFunction(node.body.body)
|
|
scriptRefs.push(...newScriptRefs)
|
|
}
|
|
}),
|
|
utils.defineScriptSetupVisitor(context, {
|
|
Program(node) {
|
|
const newScriptRefs = getScriptRefsFromSetupFunction(node.body)
|
|
|
|
scriptRefs.push(...newScriptRefs)
|
|
}
|
|
}),
|
|
{
|
|
'Program:exit'() {
|
|
for (const templateRef of templateRefs) {
|
|
const scriptRef = scriptRefs.find(
|
|
(scriptRef) => scriptRef.ref === templateRef
|
|
)
|
|
|
|
if (!scriptRef) {
|
|
continue
|
|
}
|
|
|
|
context.report({
|
|
node: scriptRef.node,
|
|
messageId: 'preferUseTemplateRef',
|
|
data: {
|
|
// @ts-ignore
|
|
name: scriptRef.node?.callee?.name
|
|
}
|
|
})
|
|
}
|
|
}
|
|
}
|
|
)
|
|
}
|
|
}
|