eslint-plugin-vue/dist/rules/block-order.js

Official ESLint plugin for Vue.js

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

//#region lib/rules/block-order.ts
var import_utils = /* @__PURE__ */ require_runtime.__toESM(require_index.default);
const DEFAULT_ORDER = Object.freeze([["script", "template"], "style"]);
function getAttributeString(element) {
	return element.startTag.attributes.map((attribute) => {
		if (attribute.value && attribute.value.type !== "VLiteral") return "";
		return `${attribute.key.name}${attribute.value && attribute.value.value ? `=${attribute.value.value}` : ""}`;
	}).join(" ");
}
var block_order_default = {
	meta: {
		type: "suggestion",
		docs: {
			description: "enforce order of component top-level elements",
			categories: ["vue3-recommended", "vue2-recommended"],
			url: "https://eslint.vuejs.org/rules/block-order.html"
		},
		fixable: "code",
		schema: [{
			type: "object",
			properties: { order: {
				type: "array",
				items: { oneOf: [{ type: "string" }, {
					type: "array",
					items: { type: "string" },
					uniqueItems: true
				}] },
				uniqueItems: true,
				additionalItems: false
			} },
			additionalProperties: false
		}],
		messages: { unexpected: "'<{{elementName}}{{elementAttributes}}>' should be above '<{{firstUnorderedName}}{{firstUnorderedAttributes}}>' on line {{line}}." }
	},
	create(context) {
		const orders = [];
		const orderOptions = context.options[0] && context.options[0].order || DEFAULT_ORDER;
		for (const [index, selectorOrSelectors] of orderOptions.entries()) if (Array.isArray(selectorOrSelectors)) for (const selector of selectorOrSelectors) orders.push({
			selectorText: selector,
			selector: require_selector.parseSelector(selector, context),
			index
		});
		else orders.push({
			selectorText: selectorOrSelectors,
			selector: require_selector.parseSelector(selectorOrSelectors, context),
			index
		});
		function getOrderElement(element) {
			return orders.find((o) => o.selector.test(element));
		}
		const sourceCode = context.sourceCode;
		const documentFragment = sourceCode.parserServices.getDocumentFragment && sourceCode.parserServices.getDocumentFragment();
		function getTopLevelHTMLElements() {
			if (documentFragment) return documentFragment.children.filter(import_utils.default.isVElement);
			return [];
		}
		return { Program(node) {
			if (import_utils.default.hasInvalidEOF(node)) return;
			const elements = getTopLevelHTMLElements();
			const elementsWithOrder = elements.flatMap((element) => {
				const order = getOrderElement(element);
				return order ? [{
					order,
					element
				}] : [];
			});
			for (const [index, elementWithOrders] of elementsWithOrder.entries()) {
				const { order: expected, element } = elementWithOrders;
				const firstUnordered = elementsWithOrder.slice(0, index).filter(({ order }) => expected.index < order.index).sort((e1, e2) => e1.order.index - e2.order.index)[0];
				if (firstUnordered) {
					const firstUnorderedAttributes = getAttributeString(firstUnordered.element);
					const elementAttributes = getAttributeString(element);
					context.report({
						node: element,
						loc: element.loc,
						messageId: "unexpected",
						data: {
							elementName: element.name,
							elementAttributes: elementAttributes ? ` ${elementAttributes}` : "",
							firstUnorderedName: firstUnordered.element.name,
							firstUnorderedAttributes: firstUnorderedAttributes ? ` ${firstUnorderedAttributes}` : "",
							line: firstUnordered.element.loc.start.line
						},
						*fix(fixer) {
							const fixedElements = elements.flatMap((it) => {
								if (it === firstUnordered.element) return [element, it];
								else if (it === element) return [];
								return [it];
							});
							for (let i = elements.length - 1; i >= 0; i--) if (elements[i] !== fixedElements[i]) yield fixer.replaceTextRange(elements[i].range, sourceCode.text.slice(...fixedElements[i].range));
						}
					});
				}
			}
		} };
	}
};

//#endregion
exports.default = block_order_default;