You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
139 lines
3.9 KiB
139 lines
3.9 KiB
/** |
|
* @fileoverview Disallow variable declarations from shadowing variables declared in the outer scope. |
|
* @author Armano |
|
*/ |
|
'use strict' |
|
|
|
// ------------------------------------------------------------------------------ |
|
// Requirements |
|
// ------------------------------------------------------------------------------ |
|
|
|
const utils = require('../utils') |
|
|
|
/** |
|
* @typedef {import('../utils').GroupName} GroupName |
|
*/ |
|
|
|
// ------------------------------------------------------------------------------ |
|
// Rule Definition |
|
// ------------------------------------------------------------------------------ |
|
|
|
/** @type {GroupName[]} */ |
|
const GROUP_NAMES = [ |
|
'props', |
|
'computed', |
|
'data', |
|
'asyncData', |
|
'methods', |
|
'setup' |
|
] |
|
|
|
module.exports = { |
|
meta: { |
|
type: 'suggestion', |
|
docs: { |
|
description: |
|
'disallow variable declarations from shadowing variables declared in the outer scope', |
|
categories: ['vue3-strongly-recommended', 'strongly-recommended'], |
|
url: 'https://eslint.vuejs.org/rules/no-template-shadow.html' |
|
}, |
|
fixable: null, |
|
schema: [] |
|
}, |
|
/** @param {RuleContext} context */ |
|
create(context) { |
|
/** @type {Set<string>} */ |
|
const jsVars = new Set() |
|
|
|
/** |
|
* @typedef {object} ScopeStack |
|
* @property {ScopeStack | null} parent |
|
* @property {Identifier[]} nodes |
|
*/ |
|
/** @type {ScopeStack | null} */ |
|
let scopeStack = null |
|
|
|
// ---------------------------------------------------------------------- |
|
// Public |
|
// ---------------------------------------------------------------------- |
|
|
|
return utils.compositingVisitors( |
|
utils.isScriptSetup(context) |
|
? { |
|
Program() { |
|
const globalScope = |
|
context.getSourceCode().scopeManager.globalScope |
|
if (!globalScope) { |
|
return |
|
} |
|
for (const variable of globalScope.variables) { |
|
if (variable.defs.length > 0) { |
|
jsVars.add(variable.name) |
|
} |
|
} |
|
const moduleScope = globalScope.childScopes.find( |
|
(scope) => scope.type === 'module' |
|
) |
|
if (!moduleScope) { |
|
return |
|
} |
|
for (const variable of moduleScope.variables) { |
|
if (variable.defs.length > 0) { |
|
jsVars.add(variable.name) |
|
} |
|
} |
|
} |
|
} |
|
: {}, |
|
utils.defineScriptSetupVisitor(context, { |
|
onDefinePropsEnter(_node, props) { |
|
for (const prop of props) { |
|
if (prop.propName) { |
|
jsVars.add(prop.propName) |
|
} |
|
} |
|
} |
|
}), |
|
utils.executeOnVue(context, (obj) => { |
|
const properties = Array.from( |
|
utils.iterateProperties(obj, new Set(GROUP_NAMES)) |
|
) |
|
for (const node of properties) { |
|
jsVars.add(node.name) |
|
} |
|
}), |
|
utils.defineTemplateBodyVisitor(context, { |
|
/** @param {VElement} node */ |
|
VElement(node) { |
|
scopeStack = { |
|
parent: scopeStack, |
|
nodes: scopeStack ? [...scopeStack.nodes] : [] |
|
} |
|
for (const variable of node.variables) { |
|
const varNode = variable.id |
|
const name = varNode.name |
|
if ( |
|
scopeStack.nodes.some((node) => node.name === name) || |
|
jsVars.has(name) |
|
) { |
|
context.report({ |
|
node: varNode, |
|
loc: varNode.loc, |
|
message: |
|
"Variable '{{name}}' is already declared in the upper scope.", |
|
data: { |
|
name |
|
} |
|
}) |
|
} else { |
|
scopeStack.nodes.push(varNode) |
|
} |
|
} |
|
}, |
|
'VElement:exit'() { |
|
scopeStack = scopeStack && scopeStack.parent |
|
} |
|
}) |
|
) |
|
} |
|
}
|
|
|