eslint-plugin-vue/dist/rules/no-restricted-props.js

Official ESLint plugin for Vue.js

'use strict';

const require_rolldown_runtime = require('../_virtual/rolldown_runtime.js');
const require_index = require('../utils/index.js');
const require_regexp$1 = require('../utils/regexp.js');

//#region lib/rules/no-restricted-props.js
/**
* @author Yosuke Ota
* See LICENSE file in root directory for full license.
*/
var require_no_restricted_props = /* @__PURE__ */ require_rolldown_runtime.__commonJSMin(((exports, module) => {
	const utils = require_index.default;
	const regexp = require_regexp$1.default;
	/**
	* @typedef {import('../utils').ComponentProp} ComponentProp
	*/
	/**
	* @typedef {object} ParsedOption
	* @property { (name: string) => boolean } test
	* @property {string|undefined} [message]
	* @property {string|undefined} [suggest]
	*/
	/**
	* @param {string|{name:string, message?: string, suggest?:string}} option
	* @returns {ParsedOption}
	*/
	function parseOption(option) {
		if (typeof option === "string") {
			const matcher = regexp.toRegExp(option, { remove: "g" });
			return { test(name) {
				return matcher.test(name);
			} };
		}
		const parsed = parseOption(option.name);
		parsed.message = option.message;
		parsed.suggest = option.suggest;
		return parsed;
	}
	module.exports = {
		meta: {
			type: "suggestion",
			docs: {
				description: "disallow specific props",
				categories: void 0,
				url: "https://eslint.vuejs.org/rules/no-restricted-props.html"
			},
			fixable: null,
			hasSuggestions: true,
			schema: {
				type: "array",
				items: { oneOf: [{ type: ["string"] }, {
					type: "object",
					properties: {
						name: { type: "string" },
						message: {
							type: "string",
							minLength: 1
						},
						suggest: { type: "string" }
					},
					required: ["name"],
					additionalProperties: false
				}] },
				uniqueItems: true,
				minItems: 0
			},
			messages: {
				restrictedProp: "{{message}}",
				instead: "Instead, change to `{{suggest}}`."
			}
		},
		create(context) {
			/** @type {ParsedOption[]} */
			const options = context.options.map(parseOption);
			/**
			* @param {ComponentProp[]} props
			* @param {(fixer: RuleFixer, propName: string, replaceKeyText: string) => Iterable<Fix>} [fixPropInOtherPlaces]
			*/
			function processProps(props, fixPropInOtherPlaces) {
				for (const prop of props) {
					if (!prop.propName) continue;
					for (const option of options) if (option.test(prop.propName)) {
						const message = option.message || `Using \`${prop.propName}\` props is not allowed.`;
						context.report({
							node: prop.type === "infer-type" ? prop.node : prop.key,
							messageId: "restrictedProp",
							data: { message },
							suggest: prop.type === "infer-type" ? null : createSuggest(prop.key, option, fixPropInOtherPlaces ? (fixer, replaceKeyText) => fixPropInOtherPlaces(fixer, prop.propName, replaceKeyText) : void 0)
						});
						break;
					}
				}
			}
			return utils.compositingVisitors(utils.defineScriptSetupVisitor(context, { onDefinePropsEnter(node, props) {
				processProps(props, fixPropInOtherPlaces);
				/**
				* @param {RuleFixer} fixer
				* @param {string} propName
				* @param {string} replaceKeyText
				*/
				function fixPropInOtherPlaces(fixer, propName, replaceKeyText) {
					/** @type {(Property|AssignmentProperty)[]} */
					const propertyNodes = [];
					const withDefault = utils.getWithDefaultsProps(node)[propName];
					if (withDefault) propertyNodes.push(withDefault);
					const propDestructure = utils.getPropsDestructure(node)[propName];
					if (propDestructure) propertyNodes.push(propDestructure);
					return propertyNodes.map((propertyNode) => propertyNode.shorthand ? fixer.insertTextBefore(propertyNode.value, `${replaceKeyText}:`) : fixer.replaceText(propertyNode.key, replaceKeyText));
				}
			} }), utils.defineVueVisitor(context, { onVueObjectEnter(node) {
				processProps(utils.getComponentPropsFromOptions(node));
			} }));
		}
	};
	/**
	* @param {Expression} node
	* @param {ParsedOption} option
	* @param {(fixer: RuleFixer, replaceKeyText: string) => Iterable<Fix>} [fixPropInOtherPlaces]
	* @returns {Rule.SuggestionReportDescriptor[]}
	*/
	function createSuggest(node, option, fixPropInOtherPlaces) {
		if (!option.suggest) return [];
		/** @type {string} */
		let replaceText;
		if (node.type === "Literal" || node.type === "TemplateLiteral") replaceText = JSON.stringify(option.suggest);
		else if (node.type === "Identifier") replaceText = /^[a-z]\w*$/iu.test(option.suggest) ? option.suggest : JSON.stringify(option.suggest);
		else return [];
		return [{
			fix(fixer) {
				const fixes = [fixer.replaceText(node, replaceText)];
				if (fixPropInOtherPlaces) fixes.push(...fixPropInOtherPlaces(fixer, replaceText));
				return fixes.sort((a, b) => a.range[0] - b.range[0]);
			},
			messageId: "instead",
			data: { suggest: option.suggest }
		}];
	}
}));

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