stylelint/lib/rules/layer-name-pattern/index.mjs

A mighty CSS linter that helps you avoid errors and enforce conventions.

import valueParser from 'postcss-value-parser';

import { atRuleRegexes, mayIncludeRegexes } from '../../utils/regexes.mjs';
import { isRegExp, isString } from '../../utils/validateTypes.mjs';
import { isValueFunction, isValueWord } from '../../utils/typeGuards.mjs';
import { atRuleParamIndex } from '../../utils/nodeFieldIndices.mjs';
import report from '../../utils/report.mjs';
import ruleMessages from '../../utils/ruleMessages.mjs';
import validateOptions from '../../utils/validateOptions.mjs';

const ruleName = 'layer-name-pattern';

const messages = ruleMessages(ruleName, {
	expected: (name, pattern) => `Expected "${name}" to match pattern "${pattern}"`,
});

const meta = {
	url: 'https://stylelint.io/user-guide/rules/layer-name-pattern',
};

/** @type {import('stylelint').CoreRules[ruleName]} */
const rule = (primary) => {
	return (root, result) => {
		const validOptions = validateOptions(result, ruleName, {
			actual: primary,
			possible: [isRegExp, isString],
		});

		if (!validOptions) return;

		const pattern = isString(primary) ? new RegExp(primary) : primary;

		root.walkAtRules(atRuleRegexes.layerName, (atRule) => {
			const { params } = atRule;

			if (!params) return;

			const parsedParams = valueParser(params);

			parsedParams.walk((node) => {
				check(node, atRule);
			});
		});

		root.walkAtRules(atRuleRegexes.importName, (atRule) => {
			const { params } = atRule;

			if (!mayIncludeRegexes.layerFunction.test(params)) return;

			const parsedParams = valueParser(atRule.params);

			parsedParams.walk((node) => {
				if (!isValueFunction(node) || node.value.toLowerCase() !== 'layer') return;

				for (const child of node.nodes) {
					check(child, atRule);
				}
			});
		});

		/**
		 * @param {import('postcss-value-parser').Node} node
		 * @param {import('postcss').AtRule} atRule
		 */
		function check(node, atRule) {
			if (!isValueWord(node)) return;

			const { value, sourceIndex } = node;

			if (pattern.test(value)) return;

			const index = atRuleParamIndex(atRule) + sourceIndex;
			const endIndex = index + value.length;

			report({
				message: messages.expected,
				messageArgs: [value, primary],
				node: atRule,
				index,
				endIndex,
				ruleName,
				result,
			});
		}
	};
};

rule.ruleName = ruleName;
rule.messages = messages;
rule.meta = meta;

export default rule;