'use strict'; const hasBlock = require('../../utils/hasBlock'); const isStandardSyntaxRule = require('../../utils/isStandardSyntaxRule'); const optionsMatches = require('../../utils/optionsMatches'); const parser = require('postcss-selector-parser'); const report = require('../../utils/report'); const ruleMessages = require('../../utils/ruleMessages'); const validateOptions = require('../../utils/validateOptions'); const { isAtRule, isDeclaration, isRoot, isRule } = require('../../utils/typeGuards'); const { isNumber, isRegExp, isString } = require('../../utils/validateTypes'); const ruleName = 'max-nesting-depth'; const messages = ruleMessages(ruleName, { expected: (depth) => `Expected nesting depth to be no more than ${depth}`, }); const meta = { url: 'https://stylelint.io/user-guide/rules/max-nesting-depth', }; /** @type {import('stylelint').Rule} */ const rule = (primary, secondaryOptions) => { /** * @param {import('postcss').Node} node */ const isIgnoreAtRule = (node) => isAtRule(node) && optionsMatches(secondaryOptions, 'ignoreAtRules', node.name); /** * @param {import('postcss').Node} node */ const isIgnoreRule = (node) => { return isRule(node) && optionsMatches(secondaryOptions, 'ignoreRules', node.selector); }; return (root, result) => { const validOptions = validateOptions( result, ruleName, { actual: primary, possible: [isNumber], }, { optional: true, actual: secondaryOptions, possible: { ignore: ['blockless-at-rules', 'pseudo-classes'], ignoreAtRules: [isString, isRegExp], ignoreRules: [isString, isRegExp], ignorePseudoClasses: [isString, isRegExp], }, }, ); if (!validOptions) return; root.walkRules(checkStatement); root.walkAtRules(checkStatement); /** * @param {import('postcss').Rule | import('postcss').AtRule} statement */ function checkStatement(statement) { if (isIgnoreAtRule(statement)) { return; } if (isIgnoreRule(statement)) { return; } if (!hasBlock(statement)) { return; } if (isRule(statement) && !isStandardSyntaxRule(statement)) { return; } const depth = nestingDepth(statement, 0); if (depth > primary) { report({ ruleName, result, node: statement, message: messages.expected, messageArgs: [primary], }); } } }; /** * @param {import('postcss').Node} node * @param {number} level * @returns {number} */ function nestingDepth(node, level) { const parent = node.parent; if (!parent) { return 0; } if (isIgnoreAtRule(parent)) { return 0; } // The nesting depth level's computation has finished // when this function, recursively called, receives // a node that is not nested -- a direct child of the // root node if (isRoot(parent) || (isAtRule(parent) && parent.parent && isRoot(parent.parent))) { return level; } /** * @param {string} selector */ function containsPseudoClassesOnly(selector) { const normalized = parser().processSync(selector, { lossless: false }); const selectors = normalized.split(','); return selectors.every((sel) => extractPseudoRule(sel)); } /** * @param {string[]} selectors * @returns {boolean} */ function containsIgnoredPseudoClassesOrRulesOnly(selectors) { if ( !( secondaryOptions && (secondaryOptions.ignorePseudoClasses || secondaryOptions.ignoreRules) ) ) return false; return selectors.every((selector) => { if ( secondaryOptions.ignoreRules && optionsMatches(secondaryOptions, 'ignoreRules', selector) ) return true; if (!secondaryOptions.ignorePseudoClasses) return false; const pseudoRule = extractPseudoRule(selector); if (!pseudoRule) return false; return optionsMatches(secondaryOptions, 'ignorePseudoClasses', pseudoRule); }); } if ( (optionsMatches(secondaryOptions, 'ignore', 'blockless-at-rules') && isAtRule(node) && node.every((child) => !isDeclaration(child))) || (optionsMatches(secondaryOptions, 'ignore', 'pseudo-classes') && isRule(node) && containsPseudoClassesOnly(node.selector)) || (isRule(node) && containsIgnoredPseudoClassesOrRulesOnly(node.selectors)) ) { return nestingDepth(parent, level); } // Unless any of the conditions above apply, we want to // add 1 to the nesting depth level and then check the parent, // continuing to add and move up the hierarchy // until we hit the root node return nestingDepth(parent, level + 1); } }; /** * @param {string} selector * @returns {string | undefined} */ function extractPseudoRule(selector) { return selector.startsWith('&:') && selector[2] !== ':' ? selector.slice(2) : undefined; } rule.ruleName = ruleName; rule.messages = messages; rule.meta = meta; module.exports = rule;