eslint-plugin-vue
Version:
Official ESLint plugin for Vue.js
1,580 lines (1,475 loc) • 83 kB
JavaScript
/**
* @author Toru Nagashima <https://github.com/mysticatea>
* @copyright 2017 Toru Nagashima. All rights reserved.
* See LICENSE file in root directory for full license.
*/
'use strict'
/**
* @typedef {import('eslint').Rule.RuleModule} RuleModule
* @typedef {import('estree').Position} Position
* @typedef {import('eslint').Rule.CodePath} CodePath
* @typedef {import('eslint').Rule.CodePathSegment} CodePathSegment
*/
/**
* @typedef {import('../../typings/eslint-plugin-vue/util-types/utils').ComponentArrayProp} ComponentArrayProp
* @typedef {import('../../typings/eslint-plugin-vue/util-types/utils').ComponentObjectProp} ComponentObjectProp
* @typedef {import('../../typings/eslint-plugin-vue/util-types/utils').ComponentTypeProp} ComponentTypeProp
* @typedef {import('../../typings/eslint-plugin-vue/util-types/utils').ComponentArrayEmit} ComponentArrayEmit
* @typedef {import('../../typings/eslint-plugin-vue/util-types/utils').ComponentObjectEmit} ComponentObjectEmit
* @typedef {import('../../typings/eslint-plugin-vue/util-types/utils').ComponentTypeEmit} ComponentTypeEmit
*/
/**
* @typedef { {key: string | null, value: BlockStatement | null} } ComponentComputedProperty
*/
/**
* @typedef { 'props' | 'data' | 'computed' | 'setup' | 'watch' | 'methods' | 'provide' | 'inject' | 'expose' } GroupName
* @typedef { { type: 'array', name: string, groupName: GroupName, node: Literal | TemplateLiteral } } ComponentArrayPropertyData
* @typedef { { type: 'object', name: string, groupName: GroupName, node: Identifier | Literal | TemplateLiteral, property: Property } } ComponentObjectPropertyData
* @typedef { ComponentArrayPropertyData | ComponentObjectPropertyData } ComponentPropertyData
*/
/**
* @typedef {import('../../typings/eslint-plugin-vue/util-types/utils').VueObjectType} VueObjectType
* @typedef {import('../../typings/eslint-plugin-vue/util-types/utils').VueObjectData} VueObjectData
* @typedef {import('../../typings/eslint-plugin-vue/util-types/utils').VueVisitor} VueVisitor
* @typedef {import('../../typings/eslint-plugin-vue/util-types/utils').ScriptSetupVisitor} ScriptSetupVisitor
*/
// ------------------------------------------------------------------------------
// Helpers
// ------------------------------------------------------------------------------
const HTML_ELEMENT_NAMES = new Set(require('./html-elements.json'))
const SVG_ELEMENT_NAMES = new Set(require('./svg-elements.json'))
const VOID_ELEMENT_NAMES = new Set(require('./void-elements.json'))
const VUE2_BUILTIN_COMPONENT_NAMES = new Set(
require('./vue2-builtin-components')
)
const VUE3_BUILTIN_COMPONENT_NAMES = new Set(
require('./vue3-builtin-components')
)
const path = require('path')
const vueEslintParser = require('vue-eslint-parser')
const { traverseNodes, getFallbackKeys } = vueEslintParser.AST
const { findVariable } = require('eslint-utils')
const {
getComponentPropsFromTypeDefine,
getComponentEmitsFromTypeDefine
} = require('./ts-ast-utils')
/**
* @type { WeakMap<RuleContext, Token[]> }
*/
const componentComments = new WeakMap()
/** @type { Map<string, RuleModule> | null } */
let ruleMap = null
/**
* Get the core rule implementation from the rule name
* @param {string} name
* @returns {RuleModule}
*/
function getCoreRule(name) {
const map = ruleMap || (ruleMap = new (require('eslint').Linter)().getRules())
return map.get(name) || require(`eslint/lib/rules/${name}`)
}
/**
* Wrap the rule context object to override methods which access to tokens (such as getTokenAfter).
* @param {RuleContext} context The rule context object.
* @param {ParserServices.TokenStore} tokenStore The token store object for template.
* @param {Object} options The option of this rule.
* @param {boolean} [options.applyDocument] If `true`, apply check to document fragment.
* @returns {RuleContext}
*/
function wrapContextToOverrideTokenMethods(context, tokenStore, options) {
const eslintSourceCode = context.getSourceCode()
const rootNode = options.applyDocument
? context.parserServices.getDocumentFragment &&
context.parserServices.getDocumentFragment()
: eslintSourceCode.ast.templateBody
/** @type {Token[] | null} */
let tokensAndComments = null
function getTokensAndComments() {
if (tokensAndComments) {
return tokensAndComments
}
tokensAndComments = rootNode
? tokenStore.getTokens(rootNode, {
includeComments: true
})
: []
return tokensAndComments
}
/** @param {number} index */
function getNodeByRangeIndex(index) {
if (!rootNode) {
return eslintSourceCode.ast
}
/** @type {ASTNode} */
let result = eslintSourceCode.ast
/** @type {ASTNode[]} */
const skipNodes = []
let breakFlag = false
traverseNodes(rootNode, {
enterNode(node, parent) {
if (breakFlag) {
return
}
if (skipNodes[0] === parent) {
skipNodes.unshift(node)
return
}
if (node.range[0] <= index && index < node.range[1]) {
result = node
} else {
skipNodes.unshift(node)
}
},
leaveNode(node) {
if (breakFlag) {
return
}
if (result === node) {
breakFlag = true
} else if (skipNodes[0] === node) {
skipNodes.shift()
}
}
})
return result
}
const sourceCode = new Proxy(Object.assign({}, eslintSourceCode), {
get(_object, key) {
if (key === 'tokensAndComments') {
return getTokensAndComments()
}
if (key === 'getNodeByRangeIndex') {
return getNodeByRangeIndex
}
// @ts-expect-error
return key in tokenStore ? tokenStore[key] : eslintSourceCode[key]
}
})
const containerScopes = new WeakMap()
/**
* @param {ASTNode} node
*/
function getContainerScope(node) {
const exprContainer = getVExpressionContainer(node)
if (!exprContainer) {
return null
}
const cache = containerScopes.get(exprContainer)
if (cache) {
return cache
}
const programNode = eslintSourceCode.ast
const parserOptions = context.parserOptions || {}
const ecmaFeatures = parserOptions.ecmaFeatures || {}
const ecmaVersion = parserOptions.ecmaVersion || 2020
const sourceType = programNode.sourceType
try {
const eslintScope = createRequire(require.resolve('eslint'))(
'eslint-scope'
)
const expStmt = new Proxy(exprContainer, {
get(_object, key) {
if (key === 'type') {
return 'ExpressionStatement'
}
// @ts-expect-error
return exprContainer[key]
}
})
const scopeProgram = new Proxy(programNode, {
get(_object, key) {
if (key === 'body') {
return [expStmt]
}
// @ts-expect-error
return programNode[key]
}
})
const scope = eslintScope.analyze(scopeProgram, {
ignoreEval: true,
nodejsScope: false,
impliedStrict: ecmaFeatures.impliedStrict,
ecmaVersion,
sourceType,
fallback: getFallbackKeys
})
containerScopes.set(exprContainer, scope)
return scope
} catch (e) {
// ignore
// console.log(e)
}
return null
}
return {
// @ts-expect-error
__proto__: context,
getSourceCode() {
return sourceCode
},
getDeclaredVariables(node) {
const scope = getContainerScope(node)
if (scope) {
return scope.getDeclaredVariables(node)
}
return context.getDeclaredVariables(node)
}
}
}
/**
* Wrap the rule context object to override report method to skip the dynamic argument.
* @param {RuleContext} context The rule context object.
* @returns {RuleContext}
*/
function wrapContextToOverrideReportMethodToSkipDynamicArgument(context) {
const sourceCode = context.getSourceCode()
const templateBody = sourceCode.ast.templateBody
if (!templateBody) {
return context
}
/** @type {Range[]} */
const directiveKeyRanges = []
const traverseNodes = vueEslintParser.AST.traverseNodes
traverseNodes(templateBody, {
enterNode(node, parent) {
if (
parent &&
parent.type === 'VDirectiveKey' &&
node.type === 'VExpressionContainer'
) {
directiveKeyRanges.push(node.range)
}
},
leaveNode() {}
})
return {
// @ts-expect-error
__proto__: context,
report(descriptor, ...args) {
let range = null
if (descriptor.loc) {
const startLoc = descriptor.loc.start || descriptor.loc
const endLoc = descriptor.loc.end || startLoc
range = [
sourceCode.getIndexFromLoc(startLoc),
sourceCode.getIndexFromLoc(endLoc)
]
} else if (descriptor.node) {
range = descriptor.node.range
}
if (range) {
for (const directiveKeyRange of directiveKeyRanges) {
if (
range[0] < directiveKeyRange[1] &&
directiveKeyRange[0] < range[1]
) {
return
}
}
}
context.report(descriptor, ...args)
}
}
}
// ------------------------------------------------------------------------------
// Exports
// ------------------------------------------------------------------------------
module.exports = {
/**
* Register the given visitor to parser services.
* If the parser service of `vue-eslint-parser` was not found,
* this generates a warning.
*
* @param {RuleContext} context The rule context to use parser services.
* @param {TemplateListener} templateBodyVisitor The visitor to traverse the template body.
* @param {RuleListener} [scriptVisitor] The visitor to traverse the script.
* @param { { templateBodyTriggerSelector: "Program" | "Program:exit" } } [options] The options.
* @returns {RuleListener} The merged visitor.
*/
defineTemplateBodyVisitor,
/**
* Register the given visitor to parser services.
* If the parser service of `vue-eslint-parser` was not found,
* this generates a warning.
*
* @param {RuleContext} context The rule context to use parser services.
* @param {TemplateListener} documentVisitor The visitor to traverse the document.
* @param { { triggerSelector: "Program" | "Program:exit" } } [options] The options.
* @returns {RuleListener} The merged visitor.
*/
defineDocumentVisitor,
/**
* Wrap a given core rule to apply it to Vue.js template.
* @param {string} coreRuleName The name of the core rule implementation to wrap.
* @param {Object} [options] The option of this rule.
* @param {string[]} [options.categories] The categories of this rule.
* @param {boolean} [options.skipDynamicArguments] If `true`, skip validation within dynamic arguments.
* @param {boolean} [options.skipDynamicArgumentsReport] If `true`, skip report within dynamic arguments.
* @param {boolean} [options.applyDocument] If `true`, apply check to document fragment.
* @param { (context: RuleContext, options: { coreHandlers: RuleListener }) => TemplateListener } [options.create] If define, extend core rule.
* @returns {RuleModule} The wrapped rule implementation.
*/
wrapCoreRule(coreRuleName, options) {
const coreRule = getCoreRule(coreRuleName)
const {
categories,
skipDynamicArguments,
skipDynamicArgumentsReport,
applyDocument,
create
} = options || {}
return {
create(context) {
const tokenStore =
context.parserServices.getTemplateBodyTokenStore &&
context.parserServices.getTemplateBodyTokenStore()
// The `context.getSourceCode()` cannot access the tokens of templates.
// So override the methods which access to tokens by the `tokenStore`.
if (tokenStore) {
context = wrapContextToOverrideTokenMethods(context, tokenStore, {
applyDocument
})
}
if (skipDynamicArgumentsReport) {
context =
wrapContextToOverrideReportMethodToSkipDynamicArgument(context)
}
// Move `Program` handlers to `VElement[parent.type!='VElement']`
const coreHandlers = coreRule.create(context)
const handlers = /** @type {TemplateListener} */ (
Object.assign({}, coreHandlers)
)
if (handlers.Program) {
handlers[
applyDocument
? 'VDocumentFragment'
: "VElement[parent.type!='VElement']"
] = /** @type {any} */ (handlers.Program)
delete handlers.Program
}
if (handlers['Program:exit']) {
handlers[
applyDocument
? 'VDocumentFragment:exit'
: "VElement[parent.type!='VElement']:exit"
] = /** @type {any} */ (handlers['Program:exit'])
delete handlers['Program:exit']
}
if (skipDynamicArguments) {
let withinDynamicArguments = false
for (const name of Object.keys(handlers)) {
const original = handlers[name]
/** @param {any[]} args */
handlers[name] = (...args) => {
if (withinDynamicArguments) return
// @ts-expect-error
original(...args)
}
}
handlers['VDirectiveKey > VExpressionContainer'] = () => {
withinDynamicArguments = true
}
handlers['VDirectiveKey > VExpressionContainer:exit'] = () => {
withinDynamicArguments = false
}
}
if (create) {
compositingVisitors(handlers, create(context, { coreHandlers }))
}
if (applyDocument) {
// Apply the handlers to document.
return defineDocumentVisitor(context, handlers)
}
// Apply the handlers to templates.
return defineTemplateBodyVisitor(context, handlers)
},
meta: Object.assign({}, coreRule.meta, {
docs: Object.assign({}, coreRule.meta.docs, {
category: null,
categories,
url: `https://eslint.vuejs.org/rules/${path.basename(
coreRule.meta.docs.url || ''
)}.html`,
extensionRule: true,
coreRuleUrl: coreRule.meta.docs.url
})
})
}
},
/**
* Checks whether the given value is defined.
* @template T
* @param {T | null | undefined} v
* @returns {v is T}
*/
isDef,
/**
* Get the previous sibling element of the given element.
* @param {VElement} node The element node to get the previous sibling element.
* @returns {VElement|null} The previous sibling element.
*/
prevSibling(node) {
let prevElement = null
for (const siblingNode of (node.parent && node.parent.children) || []) {
if (siblingNode === node) {
return prevElement
}
if (siblingNode.type === 'VElement') {
prevElement = siblingNode
}
}
return null
},
/**
* Check whether the given directive attribute has their empty value (`=""`).
* @param {VDirective} node The directive attribute node to check.
* @param {RuleContext} context The rule context to use parser services.
* @returns {boolean} `true` if the directive attribute has their empty value (`=""`).
*/
isEmptyValueDirective(node, context) {
if (node.value == null) {
return false
}
if (node.value.expression != null) {
return false
}
let valueText = context.getSourceCode().getText(node.value)
if (
(valueText[0] === '"' || valueText[0] === "'") &&
valueText[0] === valueText[valueText.length - 1]
) {
// quoted
valueText = valueText.slice(1, -1)
}
if (!valueText) {
// empty
return true
}
return false
},
/**
* Check whether the given directive attribute has their empty expression value (e.g. `=" "`, `="/* */"`).
* @param {VDirective} node The directive attribute node to check.
* @param {RuleContext} context The rule context to use parser services.
* @returns {boolean} `true` if the directive attribute has their empty expression value.
*/
isEmptyExpressionValueDirective(node, context) {
if (node.value == null) {
return false
}
if (node.value.expression != null) {
return false
}
const valueNode = node.value
const tokenStore = context.parserServices.getTemplateBodyTokenStore()
let quote1 = null
let quote2 = null
// `node.value` may be only comments, so cannot get the correct tokens with `tokenStore.getTokens(node.value)`.
for (const token of tokenStore.getTokens(node)) {
if (token.range[1] <= valueNode.range[0]) {
continue
}
if (valueNode.range[1] <= token.range[0]) {
// empty
return true
}
if (
!quote1 &&
token.type === 'Punctuator' &&
(token.value === '"' || token.value === "'")
) {
quote1 = token
continue
}
if (
!quote2 &&
quote1 &&
token.type === 'Punctuator' &&
token.value === quote1.value
) {
quote2 = token
continue
}
// not empty
return false
}
// empty
return true
},
/**
* Get the attribute which has the given name.
* @param {VElement} node The start tag node to check.
* @param {string} name The attribute name to check.
* @param {string} [value] The attribute value to check.
* @returns {VAttribute | null} The found attribute.
*/
getAttribute,
/**
* Check whether the given start tag has specific directive.
* @param {VElement} node The start tag node to check.
* @param {string} name The attribute name to check.
* @param {string} [value] The attribute value to check.
* @returns {boolean} `true` if the start tag has the attribute.
*/
hasAttribute,
/**
* Get the directive list which has the given name.
* @param {VElement | VStartTag} node The start tag node to check.
* @param {string} name The directive name to check.
* @returns {VDirective[]} The array of `v-slot` directives.
*/
getDirectives,
/**
* Get the directive which has the given name.
* @param {VElement} node The start tag node to check.
* @param {string} name The directive name to check.
* @param {string} [argument] The directive argument to check.
* @returns {VDirective | null} The found directive.
*/
getDirective,
/**
* Check whether the given start tag has specific directive.
* @param {VElement} node The start tag node to check.
* @param {string} name The directive name to check.
* @param {string} [argument] The directive argument to check.
* @returns {boolean} `true` if the start tag has the directive.
*/
hasDirective,
/**
* Returns the list of all registered components
* @param {ObjectExpression} componentObject
* @returns { { node: Property, name: string }[] } Array of ASTNodes
*/
getRegisteredComponents(componentObject) {
const componentsNode = componentObject.properties.find(
/**
* @param {ESNode} p
* @returns {p is (Property & { key: Identifier & {name: 'components'}, value: ObjectExpression })}
*/
(p) => {
return (
p.type === 'Property' &&
getStaticPropertyName(p) === 'components' &&
p.value.type === 'ObjectExpression'
)
}
)
if (!componentsNode) {
return []
}
return componentsNode.value.properties
.filter(isProperty)
.map((node) => {
const name = getStaticPropertyName(node)
return name ? { node, name } : null
})
.filter(isDef)
},
/**
* Check whether the previous sibling element has `if` or `else-if` directive.
* @param {VElement} node The element node to check.
* @returns {boolean} `true` if the previous sibling element has `if` or `else-if` directive.
*/
prevElementHasIf(node) {
const prev = this.prevSibling(node)
return (
prev != null &&
prev.startTag.attributes.some(
(a) =>
a.directive &&
(a.key.name.name === 'if' || a.key.name.name === 'else-if')
)
)
},
/**
* Returns a generator with all child element v-if chains of the given element.
* @param {VElement} node The element node to check.
* @returns {IterableIterator<VElement[]>}
*/
*iterateChildElementsChains(node) {
let vIf = false
/** @type {VElement[]} */
let elementChain = []
for (const childNode of node.children) {
if (childNode.type === 'VElement') {
let connected
if (hasDirective(childNode, 'if')) {
connected = false
vIf = true
} else if (hasDirective(childNode, 'else-if')) {
connected = vIf
vIf = true
} else if (hasDirective(childNode, 'else')) {
connected = vIf
vIf = false
} else {
connected = false
vIf = false
}
if (connected) {
elementChain.push(childNode)
} else {
if (elementChain.length) {
yield elementChain
}
elementChain = [childNode]
}
} else if (childNode.type !== 'VText' || childNode.value.trim() !== '') {
vIf = false
}
}
if (elementChain.length) {
yield elementChain
}
},
/**
* Check whether the given node is a custom component or not.
* @param {VElement} node The start tag node to check.
* @returns {boolean} `true` if the node is a custom component.
*/
isCustomComponent(node) {
return (
(this.isHtmlElementNode(node) &&
!this.isHtmlWellKnownElementName(node.rawName)) ||
(this.isSvgElementNode(node) &&
!this.isSvgWellKnownElementName(node.rawName)) ||
hasAttribute(node, 'is') ||
hasDirective(node, 'bind', 'is') ||
hasDirective(node, 'is')
)
},
/**
* Check whether the given node is a HTML element or not.
* @param {VElement} node The node to check.
* @returns {boolean} `true` if the node is a HTML element.
*/
isHtmlElementNode(node) {
return node.namespace === vueEslintParser.AST.NS.HTML
},
/**
* Check whether the given node is a SVG element or not.
* @param {VElement} node The node to check.
* @returns {boolean} `true` if the name is a SVG element.
*/
isSvgElementNode(node) {
return node.namespace === vueEslintParser.AST.NS.SVG
},
/**
* Check whether the given name is a MathML element or not.
* @param {VElement} node The node to check.
* @returns {boolean} `true` if the node is a MathML element.
*/
isMathMLElementNode(node) {
return node.namespace === vueEslintParser.AST.NS.MathML
},
/**
* Check whether the given name is an well-known element or not.
* @param {string} name The name to check.
* @returns {boolean} `true` if the name is an well-known element name.
*/
isHtmlWellKnownElementName(name) {
return HTML_ELEMENT_NAMES.has(name)
},
/**
* Check whether the given name is an well-known SVG element or not.
* @param {string} name The name to check.
* @returns {boolean} `true` if the name is an well-known SVG element name.
*/
isSvgWellKnownElementName(name) {
return SVG_ELEMENT_NAMES.has(name)
},
/**
* Check whether the given name is a void element name or not.
* @param {string} name The name to check.
* @returns {boolean} `true` if the name is a void element name.
*/
isHtmlVoidElementName(name) {
return VOID_ELEMENT_NAMES.has(name)
},
/**
* Check whether the given name is Vue builtin component name or not.
* @param {string} name The name to check.
* @returns {boolean} `true` if the name is a builtin component name
*/
isBuiltInComponentName(name) {
return (
VUE3_BUILTIN_COMPONENT_NAMES.has(name) ||
VUE2_BUILTIN_COMPONENT_NAMES.has(name)
)
},
/**
* Check whether the given name is Vue builtin directive name or not.
* @param {string} name The name to check.
* @returns {boolean} `true` if the name is a builtin Directive name
*/
isBuiltInDirectiveName(name) {
return (
name === 'bind' ||
name === 'on' ||
name === 'text' ||
name === 'html' ||
name === 'show' ||
name === 'if' ||
name === 'else' ||
name === 'else-if' ||
name === 'for' ||
name === 'model' ||
name === 'slot' ||
name === 'pre' ||
name === 'cloak' ||
name === 'once' ||
name === 'memo' ||
name === 'is'
)
},
/**
* Gets the property name of a given node.
* @param {Property|AssignmentProperty|MethodDefinition|MemberExpression} node - The node to get.
* @return {string|null} The property name if static. Otherwise, null.
*/
getStaticPropertyName,
/**
* Gets the string of a given node.
* @param {Literal|TemplateLiteral} node - The node to get.
* @return {string|null} The string if static. Otherwise, null.
*/
getStringLiteralValue,
/**
* Get all props by looking at all component's properties
* @param {ObjectExpression} componentObject Object with component definition
* @return {(ComponentArrayProp | ComponentObjectProp)[]} Array of component props in format: [{key?: String, value?: ASTNode, node: ASTNod}]
*/
getComponentProps(componentObject) {
const propsNode = componentObject.properties.find(
/**
* @param {ESNode} p
* @returns {p is (Property & { key: Identifier & {name: 'props'}, value: ObjectExpression | ArrayExpression })}
*/
(p) => {
return (
p.type === 'Property' &&
getStaticPropertyName(p) === 'props' &&
(p.value.type === 'ObjectExpression' ||
p.value.type === 'ArrayExpression')
)
}
)
if (!propsNode) {
return []
}
return getComponentPropsFromDefine(propsNode.value)
},
/**
* Get all emits by looking at all component's properties
* @param {ObjectExpression} componentObject Object with component definition
* @return {(ComponentArrayEmit | ComponentObjectEmit)[]} Array of component emits in format: [{key?: String, value?: ASTNode, node: ASTNod}]
*/
getComponentEmits(componentObject) {
const emitsNode = componentObject.properties.find(
/**
* @param {ESNode} p
* @returns {p is (Property & { key: Identifier & {name: 'emits'}, value: ObjectExpression | ArrayExpression })}
*/
(p) => {
return (
p.type === 'Property' &&
getStaticPropertyName(p) === 'emits' &&
(p.value.type === 'ObjectExpression' ||
p.value.type === 'ArrayExpression')
)
}
)
if (!emitsNode) {
return []
}
return getComponentEmitsFromDefine(emitsNode.value)
},
/**
* Get all computed properties by looking at all component's properties
* @param {ObjectExpression} componentObject Object with component definition
* @return {ComponentComputedProperty[]} Array of computed properties in format: [{key: String, value: ASTNode}]
*/
getComputedProperties(componentObject) {
const computedPropertiesNode = componentObject.properties.find(
/**
* @param {ESNode} p
* @returns {p is (Property & { key: Identifier & {name: 'computed'}, value: ObjectExpression })}
*/
(p) => {
return (
p.type === 'Property' &&
getStaticPropertyName(p) === 'computed' &&
p.value.type === 'ObjectExpression'
)
}
)
if (!computedPropertiesNode) {
return []
}
return computedPropertiesNode.value.properties
.filter(isProperty)
.map((cp) => {
const key = getStaticPropertyName(cp)
/** @type {Expression} */
const propValue = skipTSAsExpression(cp.value)
/** @type {BlockStatement | null} */
let value = null
if (propValue.type === 'FunctionExpression') {
value = propValue.body
} else if (propValue.type === 'ObjectExpression') {
const get =
/** @type {(Property & { value: FunctionExpression }) | null} */ (
findProperty(
propValue,
'get',
(p) => p.value.type === 'FunctionExpression'
)
)
value = get ? get.value.body : null
}
return { key, value }
})
},
/**
* Get getter body from computed function
* @param {CallExpression} callExpression call of computed function
* @return {FunctionExpression | ArrowFunctionExpression | null} getter function
*/
getGetterBodyFromComputedFunction(callExpression) {
if (callExpression.arguments.length <= 0) {
return null
}
const arg = callExpression.arguments[0]
if (
arg.type === 'FunctionExpression' ||
arg.type === 'ArrowFunctionExpression'
) {
return arg
}
if (arg.type === 'ObjectExpression') {
const getProperty =
/** @type {(Property & { value: FunctionExpression | ArrowFunctionExpression }) | null} */ (
findProperty(
arg,
'get',
(p) =>
p.value.type === 'FunctionExpression' ||
p.value.type === 'ArrowFunctionExpression'
)
)
return getProperty ? getProperty.value : null
}
return null
},
isVueFile,
/**
* Checks whether the current file is uses `<script setup>`
* @param {RuleContext} context The ESLint rule context object.
*/
isScriptSetup,
/**
* Gets the element of `<script setup>`
* @param {RuleContext} context The ESLint rule context object.
* @returns {VElement | null} the element of `<script setup>`
*/
getScriptSetupElement,
/**
* Check if current file is a Vue instance or component and call callback
* @param {RuleContext} context The ESLint rule context object.
* @param { (node: ObjectExpression, type: VueObjectType) => void } cb Callback function
*/
executeOnVue(context, cb) {
return compositingVisitors(
this.executeOnVueComponent(context, cb),
this.executeOnVueInstance(context, cb)
)
},
/**
* Define handlers to traverse the Vue Objects.
* Some special events are available to visitor.
*
* - `onVueObjectEnter` ... Event when Vue Object is found.
* - `onVueObjectExit` ... Event when Vue Object visit ends.
* - `onSetupFunctionEnter` ... Event when setup function found.
* - `onRenderFunctionEnter` ... Event when render function found.
*
* @param {RuleContext} context The ESLint rule context object.
* @param {VueVisitor} visitor The visitor to traverse the Vue Objects.
*/
defineVueVisitor(context, visitor) {
/** @type {VueObjectData | null} */
let vueStack = null
/**
* @param {string} key
* @param {ESNode} node
*/
function callVisitor(key, node) {
if (visitor[key] && vueStack) {
// @ts-expect-error
visitor[key](node, vueStack)
}
}
/** @type {NodeListener} */
const vueVisitor = {}
for (const key in visitor) {
vueVisitor[key] = (node) => callVisitor(key, node)
}
/**
* @param {ObjectExpression} node
*/
vueVisitor.ObjectExpression = (node) => {
const type = getVueObjectType(context, node)
if (type) {
vueStack = {
node,
type,
parent: vueStack,
get functional() {
const functional = node.properties.find(
/**
* @param {Property | SpreadElement} p
* @returns {p is Property}
*/
(p) =>
p.type === 'Property' &&
getStaticPropertyName(p) === 'functional'
)
if (!functional) {
return false
}
if (
functional.value.type === 'Literal' &&
functional.value.value === false
) {
return false
}
return true
}
}
callVisitor('onVueObjectEnter', node)
}
callVisitor('ObjectExpression', node)
}
vueVisitor['ObjectExpression:exit'] = (node) => {
callVisitor('ObjectExpression:exit', node)
if (vueStack && vueStack.node === node) {
callVisitor('onVueObjectExit', node)
vueStack = vueStack.parent
}
}
if (
visitor.onSetupFunctionEnter ||
visitor.onSetupFunctionExit ||
visitor.onRenderFunctionEnter
) {
const setups = new Set()
/** @param { (FunctionExpression | ArrowFunctionExpression) & { parent: Property } } node */
vueVisitor[
'Property[value.type=/^(Arrow)?FunctionExpression$/] > :function'
] = (node) => {
/** @type {Property} */
const prop = node.parent
if (vueStack && prop.parent === vueStack.node && prop.value === node) {
const name = getStaticPropertyName(prop)
if (name === 'setup') {
callVisitor('onSetupFunctionEnter', node)
setups.add(node)
} else if (name === 'render') {
callVisitor('onRenderFunctionEnter', node)
}
}
callVisitor(
'Property[value.type=/^(Arrow)?FunctionExpression$/] > :function',
node
)
}
if (visitor.onSetupFunctionExit) {
/** @param { (FunctionExpression | ArrowFunctionExpression) & { parent: Property } } node */
vueVisitor[
'Property[value.type=/^(Arrow)?FunctionExpression$/] > :function:exit'
] = (node) => {
if (setups.has(node)) {
callVisitor('onSetupFunctionExit', node)
setups.delete(node)
}
}
}
}
return vueVisitor
},
/**
* Define handlers to traverse the AST nodes in `<script setup>`.
* Some special events are available to visitor.
*
* - `onDefinePropsEnter` ... Event when defineProps is found.
* - `onDefinePropsExit` ... Event when defineProps visit ends.
* - `onDefineEmitsEnter` ... Event when defineEmits is found.
* - `onDefineEmitsExit` ... Event when defineEmits visit ends.
*
* @param {RuleContext} context The ESLint rule context object.
* @param {ScriptSetupVisitor} visitor The visitor to traverse the AST nodes.
*/
defineScriptSetupVisitor(context, visitor) {
const scriptSetup = getScriptSetupElement(context)
if (scriptSetup == null) {
return {}
}
const scriptSetupRange = scriptSetup.range
/**
* @param {ESNode} node
*/
function inScriptSetup(node) {
return (
scriptSetupRange[0] <= node.range[0] &&
node.range[1] <= scriptSetupRange[1]
)
}
/**
* @param {string} key
* @param {ESNode} node
* @param {any[]} args
*/
function callVisitor(key, node, ...args) {
if (visitor[key]) {
if (inScriptSetup(node)) {
// @ts-expect-error
visitor[key](node, ...args)
}
}
}
/** @type {NodeListener} */
const scriptSetupVisitor = {}
for (const key in visitor) {
scriptSetupVisitor[key] = (node) => callVisitor(key, node)
}
/**
* @param {ESNode} node
* @returns {ObjectExpression | ArrayExpression | null}
*/
function getObjectOrArray(node) {
if (node.type === 'ObjectExpression') {
return node
}
if (node.type === 'ArrayExpression') {
return node
}
if (node.type === 'Identifier') {
const variable = findVariable(context.getScope(), node)
if (variable != null && variable.defs.length === 1) {
const def = variable.defs[0]
if (
def.type === 'Variable' &&
def.parent.kind === 'const' &&
def.node.id.type === 'Identifier' &&
def.node.init
) {
return getObjectOrArray(def.node.init)
}
}
}
return null
}
const hasPropsEvent =
visitor.onDefinePropsEnter || visitor.onDefinePropsExit
const hasEmitsEvent =
visitor.onDefineEmitsEnter || visitor.onDefineEmitsExit
if (hasPropsEvent || hasEmitsEvent) {
/** @type {Expression | null} */
let candidateMacro = null
/** @param {VariableDeclarator|ExpressionStatement} node */
scriptSetupVisitor[
'Program > VariableDeclaration > VariableDeclarator, Program > ExpressionStatement'
] = (node) => {
if (!candidateMacro) {
candidateMacro =
node.type === 'VariableDeclarator' ? node.init : node.expression
}
}
/** @param {VariableDeclarator|ExpressionStatement} node */
scriptSetupVisitor[
'Program > VariableDeclaration > VariableDeclarator, Program > ExpressionStatement:exit'
] = (node) => {
if (
candidateMacro ===
(node.type === 'VariableDeclarator' ? node.init : node.expression)
) {
candidateMacro = null
}
}
const definePropsMap = new Map()
const defineEmitsMap = new Map()
/**
* @param {CallExpression} node
*/
scriptSetupVisitor.CallExpression = (node) => {
if (
candidateMacro &&
inScriptSetup(node) &&
node.callee.type === 'Identifier'
) {
if (
hasPropsEvent &&
(candidateMacro === node ||
candidateMacro === getWithDefaults(node)) &&
node.callee.name === 'defineProps'
) {
/** @type {(ComponentArrayProp | ComponentObjectProp | ComponentTypeProp)[]} */
let props = []
if (node.arguments.length >= 1) {
const defNode = getObjectOrArray(node.arguments[0])
if (defNode) {
props = getComponentPropsFromDefine(defNode)
}
} else if (
node.typeParameters &&
node.typeParameters.params.length >= 1
) {
props = getComponentPropsFromTypeDefine(
context,
node.typeParameters.params[0]
)
}
callVisitor('onDefinePropsEnter', node, props)
definePropsMap.set(node, props)
} else if (
hasEmitsEvent &&
candidateMacro === node &&
node.callee.name === 'defineEmits'
) {
/** @type {(ComponentArrayEmit | ComponentObjectEmit | ComponentTypeEmit)[]} */
let emits = []
if (node.arguments.length >= 1) {
const defNode = getObjectOrArray(node.arguments[0])
if (defNode) {
emits = getComponentEmitsFromDefine(defNode)
}
} else if (
node.typeParameters &&
node.typeParameters.params.length >= 1
) {
emits = getComponentEmitsFromTypeDefine(
context,
node.typeParameters.params[0]
)
}
callVisitor('onDefineEmitsEnter', node, emits)
defineEmitsMap.set(node, emits)
}
}
callVisitor('CallExpression', node)
}
scriptSetupVisitor['CallExpression:exit'] = (node) => {
callVisitor('CallExpression:exit', node)
if (definePropsMap.has(node)) {
callVisitor('onDefinePropsExit', node, definePropsMap.get(node))
definePropsMap.delete(node)
}
if (defineEmitsMap.has(node)) {
callVisitor('onDefineEmitsExit', node, defineEmitsMap.get(node))
defineEmitsMap.delete(node)
}
}
}
return scriptSetupVisitor
},
/**
* Checks whether given defineProps call node has withDefaults.
* @param {CallExpression} node The node of defineProps
* @returns {node is CallExpression & { parent: CallExpression }}
*/
hasWithDefaults,
/**
* Gets a map of the expressions defined in withDefaults.
* @param {CallExpression} node The node of defineProps
* @returns { { [key: string]: Expression | undefined } }
*/
getWithDefaultsPropExpressions(node) {
const map = getWithDefaultsProps(node)
/** @type {Record<string, Expression | undefined>} */
const result = {}
for (const key of Object.keys(map)) {
const prop = map[key]
result[key] = prop && prop.value
}
return result
},
/**
* Gets a map of the property nodes defined in withDefaults.
* @param {CallExpression} node The node of defineProps
* @returns { { [key: string]: Property | undefined } }
*/
getWithDefaultsProps,
getVueObjectType,
/**
* Get the Vue component definition type from given node
* Vue.component('xxx', {}) || component('xxx', {})
* @param {ObjectExpression} node Node to check
* @returns {'component' | 'mixin' | 'extend' | 'createApp' | 'defineComponent' | null}
*/
getVueComponentDefinitionType,
compositingVisitors,
/**
* Check if current file is a Vue instance (new Vue) and call callback
* @param {RuleContext} context The ESLint rule context object.
* @param { (node: ObjectExpression, type: VueObjectType) => void } cb Callback function
*/
executeOnVueInstance(context, cb) {
return {
/** @param {ObjectExpression} node */
'ObjectExpression:exit'(node) {
const type = getVueObjectType(context, node)
if (!type || type !== 'instance') return
cb(node, type)
}
}
},
/**
* Check if current file is a Vue component and call callback
* @param {RuleContext} context The ESLint rule context object.
* @param { (node: ObjectExpression, type: VueObjectType) => void } cb Callback function
*/
executeOnVueComponent(context, cb) {
return {
/** @param {ObjectExpression} node */
'ObjectExpression:exit'(node) {
const type = getVueObjectType(context, node)
if (
!type ||
(type !== 'mark' && type !== 'export' && type !== 'definition')
)
return
cb(node, type)
}
}
},
/**
* Check call `Vue.component` and call callback.
* @param {RuleContext} _context The ESLint rule context object.
* @param { (node: CallExpression) => void } cb Callback function
*/
executeOnCallVueComponent(_context, cb) {
return {
/** @param {Identifier & { parent: MemberExpression & { parent: CallExpression } } } node */
"CallExpression > MemberExpression > Identifier[name='component']": (
node
) => {
const callExpr = node.parent.parent
const callee = callExpr.callee
if (callee.type === 'MemberExpression') {
const calleeObject = skipTSAsExpression(callee.object)
if (
calleeObject.type === 'Identifier' &&
// calleeObject.name === 'Vue' && // Any names can be used in Vue.js 3.x. e.g. app.component()
callee.property === node &&
callExpr.arguments.length >= 1
) {
cb(callExpr)
}
}
}
}
},
/**
* Return generator with all properties
* @param {ObjectExpression} node Node to check
* @param {Set<GroupName>} groups Name of parent group
* @returns {IterableIterator<ComponentPropertyData>}
*/
*iterateProperties(node, groups) {
for (const item of node.properties) {
if (item.type !== 'Property') {
continue
}
const name = /** @type {GroupName | null} */ (getStaticPropertyName(item))
if (!name || !groups.has(name)) continue
if (item.value.type === 'ArrayExpression') {
yield* this.iterateArrayExpression(item.value, name)
} else if (item.value.type === 'ObjectExpression') {
yield* this.iterateObjectExpression(item.value, name)
} else if (item.value.type === 'FunctionExpression') {
yield* this.iterateFunctionExpression(item.value, name)
} else if (item.value.type === 'ArrowFunctionExpression') {
yield* this.iterateArrowFunctionExpression(item.value, name)
}
}
},
/**
* Return generator with all elements inside ArrayExpression
* @param {ArrayExpression} node Node to check
* @param {GroupName} groupName Name of parent group
* @returns {IterableIterator<ComponentArrayPropertyData>}
*/
*iterateArrayExpression(node, groupName) {
for (const item of node.elements) {
if (
item &&
(item.type === 'Literal' || item.type === 'TemplateLiteral')
) {
const name = getStringLiteralValue(item)
if (name) {
yield { type: 'array', name, groupName, node: item }
}
}
}
},
/**
* Return generator with all elements inside ObjectExpression
* @param {ObjectExpression} node Node to check
* @param {GroupName} groupName Name of parent group
* @returns {IterableIterator<ComponentObjectPropertyData>}
*/
*iterateObjectExpression(node, groupName) {
/** @type {Set<Property> | undefined} */
let usedGetter
for (const item of node.properties) {
if (item.type === 'Property') {
const key = item.key
if (
key.type === 'Identifier' ||
key.type === 'Literal' ||
key.type === 'TemplateLiteral'
) {
const name = getStaticPropertyName(item)
if (name) {
if (item.kind === 'set') {
// find getter pair
if (
node.properties.some((item2) => {
if (item2.type === 'Property' && item2.kind === 'get') {
if (!usedGetter) {
usedGetter = new Set()
}
if (usedGetter.has(item2)) {
return false
}
const getterName = getStaticPropertyName(item2)
if (getterName === name) {
usedGetter.add(item2)
return true
}
}
return false
})
) {
// has getter pair
continue
}
}
yield {
type: 'object',
name,
groupName,
node: key,
property: item
}
}
}
}
}
},
/**
* Return generator with all elements inside FunctionExpression
* @param {FunctionExpression} node Node to check
* @param {GroupName} groupName Name of parent group
* @returns {IterableIterator<ComponentObjectPropertyData>}
*/
*iterateFunctionExpression(node, groupName) {
if (node.body.type === 'BlockStatement') {
for (const item of node.body.body) {
if (
item.type === 'ReturnStatement' &&
item.argument &&
item.argument.type === 'ObjectExpression'
) {
yield* this.iterateObjectExpression(item.argument, groupName)
}
}
}
},
/**
* Return generator with all elements inside ArrowFunctionExpression
* @param {ArrowFunctionExpression} node Node to check
* @param {GroupName} groupName Name of parent group
* @returns {IterableIterator<ComponentObjectPropertyData>}
*/
*iterateArrowFunctionExpression(node, groupName) {
const body = node.body
if (body.type === 'BlockStatement') {
for (const item of body.body) {
if (
item.type === 'ReturnStatement' &&
item.argument &&
item.argument.type === 'ObjectExpression'
) {
yield* this.iterateObjectExpression(item.argument, groupName)
}
}
} else if (body.type === 'ObjectExpression') {
yield* this.iterateObjectExpression(body, groupName)
}
},
/**
* Find all functions which do not always return values
* @param {boolean} treatUndefinedAsUnspecified
* @param { (node: ArrowFunctionExpression | FunctionExpression | FunctionDeclaration) => void } cb Callback function
* @returns {RuleListener}
*/
executeOnFunctionsWithoutReturn(treatUndefinedAsUnspecified, cb) {
/**
* @typedef {object} FuncInfo
* @property {FuncInfo | null} funcInfo
* @property {CodePath} codePath
* @property {boolean} hasReturn
* @property {boolean} hasReturnValue
* @property {ArrowFunctionExpression | FunctionExpression | FunctionDeclaration} node
*/
/** @type {FuncInfo | null} */
let funcInfo = null
/** @param {CodePathSegment} segment */
function isReachable(segment) {
return segment.reachable
}
function isValidReturn() {
if (!funcInfo) {
return true
}
if (
funcInfo.codePath &&
funcInfo.codePath.currentSegments.some(isReachable)
) {
return false
}
return !treatUndefinedAsUnspecified || funcInfo.hasReturnValue
}
return {
/**
* @param {CodePath} codePath
* @param {ESNode} node
*/
onCodePathStart(codePath, node) {
if (
node.type === 'ArrowFunctionExpression' ||
node.type === 'FunctionExpression' ||
node.type === 'FunctionDeclaration'
) {
funcInfo = {
codePath,
funcInfo,
hasReturn: false,
hasReturnValue: false,
node
}
}
},
onCodePathEnd() {
funcInfo = funcInfo && funcInfo.funcInfo
},
/** @param {ReturnStatement} node */
ReturnStatement(node) {
if (funcInfo) {
funcInfo.hasReturn = true
funcInfo.hasReturnValue = Boolean(node.argument)
}
},
/** @param {ArrowFunctionExpression} node */
'ArrowFu