stylelint-order/rules/properties-order/checkOrder.js

A collection of order related linting rules for Stylelint.

import { checkAlphabeticalOrder } from '../../utils/checkAlphabeticalOrder.js';
import * as vendor from '../../utils/vendor.js';

// eslint-disable-next-line consistent-return
export function checkOrder({
	firstPropertyData,
	secondPropertyData,
	allPropertiesData,
	unspecified,
}) {
	function report(isCorrect, firstNode = firstPropertyData, secondNode = secondPropertyData) {
		return {
			isCorrect,
			firstNode,
			secondNode,
		};
	}

	let firstPropName = firstPropertyData.name.toLowerCase();
	let secondPropName = secondPropertyData.name.toLowerCase();
	let firstPropUnprefixedName = firstPropertyData.unprefixedName.toLowerCase();
	let secondPropUnprefixedName = secondPropertyData.unprefixedName.toLowerCase();

	if (firstPropUnprefixedName === secondPropUnprefixedName) {
		// If first property has no prefix and second property has prefix
		if (!vendor.prefix(firstPropName).length && vendor.prefix(secondPropName).length) {
			return report(false);
		}

		return report(true);
	}

	const firstPropIsSpecified = Boolean(firstPropertyData.orderData);
	const secondPropIsSpecified = Boolean(secondPropertyData.orderData);

	// Check actual known properties
	if (firstPropIsSpecified && secondPropIsSpecified) {
		return report(
			firstPropertyData.orderData.expectedPosition <=
				secondPropertyData.orderData.expectedPosition,
		);
	}

	if (!firstPropIsSpecified && secondPropIsSpecified) {
		// If first prop is unspecified, look for a specified prop before it to
		// compare to the current prop
		let priorSpecifiedPropData = allPropertiesData
			.slice(0, -1)
			.reverse()
			.find((declaration) => Boolean(declaration.orderData));

		if (
			priorSpecifiedPropData &&
			priorSpecifiedPropData.orderData &&
			priorSpecifiedPropData.orderData.expectedPosition >
				secondPropertyData.orderData.expectedPosition
		) {
			return report(false, priorSpecifiedPropData, secondPropertyData);
		}
	}

	// Now deal with unspecified props
	// Starting with bottomAlphabetical as it requires more specific conditionals
	if (unspecified === 'bottomAlphabetical' && firstPropIsSpecified && !secondPropIsSpecified) {
		return report(true);
	}

	if (unspecified === 'bottomAlphabetical' && !firstPropIsSpecified && !secondPropIsSpecified) {
		if (checkAlphabeticalOrder(firstPropertyData, secondPropertyData)) {
			return report(true);
		}

		return report(false);
	}

	if (unspecified === 'bottomAlphabetical' && !firstPropIsSpecified) {
		return report(false);
	}

	if (!firstPropIsSpecified && !secondPropIsSpecified) {
		return report(true);
	}

	if (unspecified === 'ignore' && (!firstPropIsSpecified || !secondPropIsSpecified)) {
		return report(true);
	}

	if (unspecified === 'top' && !firstPropIsSpecified) {
		return report(true);
	}

	if (unspecified === 'top' && !secondPropIsSpecified) {
		return report(false);
	}

	if (unspecified === 'bottom' && !secondPropIsSpecified) {
		return report(true);
	}

	if (unspecified === 'bottom' && !firstPropIsSpecified) {
		return report(false);
	}
}