eslint-plugin-vue/dist/rules/require-macro-variable-name.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/require-macro-variable-name.js
/**
* @author ItMaga
* See LICENSE file in root directory for full license.
*/
var require_require_macro_variable_name = /* @__PURE__ */ require_runtime.__commonJSMin(((exports, module) => {
	const utils = require_index.default;
	const DEFAULT_OPTIONS = {
		defineProps: "props",
		defineEmits: "emit",
		defineSlots: "slots",
		useSlots: "slots",
		useAttrs: "attrs"
	};
	module.exports = {
		meta: {
			type: "suggestion",
			docs: {
				description: "require a certain macro variable name",
				categories: void 0,
				url: "https://eslint.vuejs.org/rules/require-macro-variable-name.html"
			},
			fixable: null,
			hasSuggestions: true,
			schema: [{
				type: "object",
				properties: {
					defineProps: { type: "string" },
					defineEmits: { type: "string" },
					defineSlots: { type: "string" },
					useSlots: { type: "string" },
					useAttrs: { type: "string" }
				},
				additionalProperties: false
			}],
			messages: {
				requireName: "The variable name of \"{{macroName}}\" must be \"{{variableName}}\".",
				changeName: "Change the variable name to \"{{variableName}}\"."
			}
		},
		create(context) {
			const options = Object.assign({}, DEFAULT_OPTIONS, context.options[0]);
			const relevantMacros = new Set([...Object.keys(DEFAULT_OPTIONS), "withDefaults"]);
			return utils.defineScriptSetupVisitor(context, { VariableDeclarator(node) {
				if (node.init && node.init.type === "CallExpression" && node.init.callee.type === "Identifier" && relevantMacros.has(node.init.callee.name)) {
					const macroName = node.init.callee.name === "withDefaults" ? "defineProps" : node.init.callee.name;
					if (node.id.type === "Identifier" && node.id.name !== options[macroName]) context.report({
						node: node.id,
						loc: node.id.loc,
						messageId: "requireName",
						data: {
							macroName,
							variableName: options[macroName]
						},
						suggest: [{
							messageId: "changeName",
							data: { variableName: options[macroName] },
							fix(fixer) {
								return fixer.replaceText(node.id, options[macroName]);
							}
						}]
					});
				}
			} });
		}
	};
}));

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