eslint-plugin-vue/dist/rules/require-prop-type-constructor.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-prop-type-constructor.js
/**
* @fileoverview require prop type to be a constructor
* @author Michał Sajnóg
*/
var require_require_prop_type_constructor = /* @__PURE__ */ require_runtime.__commonJSMin(((exports, module) => {
	const utils = require_index.default;
	const { isDef } = require_index.default;
	/**
	* @typedef {import('../utils').ComponentProp} ComponentProp
	*/
	const forbiddenTypes = new Set([
		"Literal",
		"TemplateLiteral",
		"BinaryExpression",
		"UpdateExpression"
	]);
	/**
	* @param {ESNode} node
	*/
	function isForbiddenType(node) {
		return forbiddenTypes.has(node.type) && !(node.type === "Literal" && node.value == null && !node.bigint);
	}
	module.exports = {
		meta: {
			type: "suggestion",
			docs: {
				description: "require prop type to be a constructor",
				categories: ["vue3-essential", "vue2-essential"],
				url: "https://eslint.vuejs.org/rules/require-prop-type-constructor.html"
			},
			fixable: "code",
			schema: [],
			messages: { propTypeConstructor: "The \"{{name}}\" property should be a constructor." }
		},
		create(context) {
			/**
			* @param {string} propName
			* @param {ESNode} node
			*/
			function checkPropertyNode(propName, node) {
				/** @type {ESNode[]} */
				const nodes = node.type === "ArrayExpression" ? node.elements.filter(isDef) : [node];
				for (const prop of nodes) {
					if (!isForbiddenType(prop)) continue;
					context.report({
						node: prop,
						messageId: "propTypeConstructor",
						data: { name: propName },
						fix: (fixer) => {
							if (prop.type === "Literal" || prop.type === "TemplateLiteral") {
								const newText = utils.getStringLiteralValue(prop, true);
								if (newText) return fixer.replaceText(prop, newText);
							}
							return null;
						}
					});
				}
			}
			/** @param {ComponentProp[]} props */
			function verifyProps(props) {
				for (const prop of props) {
					if (prop.type !== "object" || prop.propName == null) continue;
					if (isForbiddenType(prop.value) || prop.value.type === "ArrayExpression") checkPropertyNode(prop.propName, prop.value);
					else if (prop.value.type === "ObjectExpression") {
						const typeProperty = utils.findProperty(prop.value, "type");
						if (!typeProperty) continue;
						checkPropertyNode(prop.propName, typeProperty.value);
					}
				}
			}
			return utils.compositingVisitors(utils.defineScriptSetupVisitor(context, { onDefinePropsEnter(_node, props) {
				verifyProps(props);
			} }), utils.executeOnVueComponent(context, (obj) => {
				verifyProps(utils.getComponentPropsFromOptions(obj));
			}));
		}
	};
}));

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