eslint-plugin-vue/dist/rules/no-template-shadow.js

Official ESLint plugin for Vue.js

'use strict';

const require_runtime = require('../_virtual/_rolldown/runtime.js');
const require_index = require('../utils/index.js');

//#region lib/rules/no-template-shadow.js
/**
* @fileoverview Disallow variable declarations from shadowing variables declared in the outer scope.
* @author Armano
*/
var require_no_template_shadow = /* @__PURE__ */ require_runtime.__commonJSMin(((exports, module) => {
	const utils = require_index.default;
	/**
	* @typedef {import('../utils').GroupName} GroupName
	*/
	/** @type {GroupName[]} */
	const GROUP_NAMES = [
		"props",
		"computed",
		"data",
		"asyncData",
		"methods",
		"setup"
	];
	/**
	* @param {RuleContext} context
	* @param {string} variableName
	*/
	function isAllowedVarName(context, variableName) {
		if (context.options[0] && context.options[0].allow) return context.options[0].allow.includes(variableName);
		return false;
	}
	module.exports = {
		meta: {
			type: "suggestion",
			docs: {
				description: "disallow variable declarations from shadowing variables declared in the outer scope",
				categories: ["vue3-strongly-recommended", "vue2-strongly-recommended"],
				url: "https://eslint.vuejs.org/rules/no-template-shadow.html"
			},
			fixable: null,
			schema: [{
				type: "object",
				properties: { allow: {
					type: "array",
					items: { type: "string" },
					uniqueItems: true
				} },
				additionalProperties: false
			}],
			messages: { alreadyDeclaredInUpperScope: "Variable '{{name}}' is already declared in the upper scope." }
		},
		create(context) {
			/** @type {Set<string>} */
			const jsVars = /* @__PURE__ */ new Set();
			/**
			* @typedef {object} ScopeStack
			* @property {ScopeStack | null} parent
			* @property {Identifier[]} nodes
			*/
			/** @type {ScopeStack | null} */
			let scopeStack = null;
			return utils.compositingVisitors(utils.isScriptSetup(context) ? { Program() {
				const globalScope = context.sourceCode.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 = utils.iterateProperties(obj, new Set(GROUP_NAMES));
				for (const node of properties) jsVars.add(node.name);
			}), utils.defineTemplateBodyVisitor(context, {
				VElement(node) {
					scopeStack = {
						parent: scopeStack,
						nodes: scopeStack ? [...scopeStack.nodes] : []
					};
					for (const variable of node.variables) {
						const varNode = variable.id;
						const name = varNode.name;
						if (isAllowedVarName(context, name)) continue;
						if (scopeStack.nodes.some((node) => node.name === name) || jsVars.has(name)) context.report({
							node: varNode,
							loc: varNode.loc,
							messageId: "alreadyDeclaredInUpperScope",
							data: { name }
						});
						else scopeStack.nodes.push(varNode);
					}
				},
				"VElement:exit"() {
					scopeStack = scopeStack && scopeStack.parent;
				}
			}));
		}
	};
}));

//#endregion
Object.defineProperty(exports, 'default', {
  enumerable: true,
  get: function () {
    return require_no_template_shadow();
  }
});