Refactor to use sourceIndices utility from `@csstools/css-parser-al…

…gorithms` (#7033)
stylelint · Jul 3, 2023 · 15c15b6 · 15c15b6
1 parent 3f91eaa
commit 15c15b6
Show file tree

Hide file tree

Showing 7 changed files with 50 additions and 139 deletions.
diff --git a/lib/rules/media-feature-name-unit-allowed-list/index.js b/lib/rules/media-feature-name-unit-allowed-list/index.js
@@ -1,15 +1,16 @@
 'use strict';
 
-const report = require('../../utils/report');
-const ruleMessages = require('../../utils/ruleMessages');
-const validateOptions = require('../../utils/validateOptions');
 const { TokenType } = require('@csstools/css-tokenizer');
 const { isTokenNode } = require('@csstools/css-parser-algorithms');
 const {
 	isMediaFeaturePlain,
 	isMediaFeatureRange,
 	isMediaQueryInvalid,
 } = require('@csstools/media-query-list-parser');
+
+const report = require('../../utils/report');
+const ruleMessages = require('../../utils/ruleMessages');
+const validateOptions = require('../../utils/validateOptions');
 const validateObjectWithArrayProps = require('../../utils/validateObjectWithArrayProps');
 const { isString } = require('../../utils/validateTypes');
 const matchesStringOrRegExp = require('../../utils/matchesStringOrRegExp');

diff --git a/lib/rules/media-feature-name-value-allowed-list/index.js b/lib/rules/media-feature-name-value-allowed-list/index.js
@@ -1,5 +1,6 @@
 'use strict';
 
+const { sourceIndices } = require('@csstools/css-parser-algorithms');
 const {
 	isMediaQueryInvalid,
 	isMediaFeature,
@@ -80,7 +81,7 @@ const rule = (primary) => {
 					}
 
 					const atRuleIndex = atRuleParamIndex(atRule);
-					const [startIndex, endIndex] = startAndEndIndex(componentValues);
+					const [startIndex, endIndex] = sourceIndices(componentValues);
 
 					report({
 						index: atRuleIndex + startIndex,
@@ -97,40 +98,6 @@ const rule = (primary) => {
 	};
 };
 
-/**
- * A recursive function that returns the start and end boundaries of a node.
- *
- * @template {import('@csstools/css-tokenizer').CSSToken} T
- * @param {Array<{ tokens(): Array<T> }> | { tokens(): Array<T> }} node
- * @returns {[number, number]}
- */
-function startAndEndIndex(node) {
-	if (Array.isArray(node)) {
-		const nodeStart = node[0];
-
-		if (!nodeStart) return [0, 0];
-
-		const nodeEnd = node[node.length - 1] || nodeStart;
-
-		const [startA] = startAndEndIndex(nodeStart);
-		const [, endB] = startAndEndIndex(nodeEnd);
-
-		return [startA, endB];
-	}
-
-	const tokens = node.tokens();
-
-	const firstToken = tokens[0];
-	const lastToken = tokens[tokens.length - 1];
-
-	if (!firstToken || !lastToken) return [0, 0];
-
-	const start = firstToken[2];
-	const end = lastToken[3];
-
-	return [start, end];
-}
-
 rule.ruleName = ruleName;
 rule.messages = messages;
 rule.meta = meta;

diff --git a/lib/rules/media-feature-name-value-no-unknown/index.js b/lib/rules/media-feature-name-value-no-unknown/index.js
@@ -1,7 +1,7 @@
 'use strict';
 
 const { TokenType, NumberType } = require('@csstools/css-tokenizer');
-const { isTokenNode, isFunctionNode } = require('@csstools/css-parser-algorithms');
+const { isTokenNode, isFunctionNode, sourceIndices } = require('@csstools/css-parser-algorithms');
 const {
 	isMediaFeature,
 	isMediaFeatureValue,
@@ -161,7 +161,7 @@ const rule = (primary) => {
 			}
 
 			// An unexpected function or a media feature that doesn't support types that can be the result of a function.
-			reporter(state, functionNode.toString(), ...startAndEndIndex(functionNode));
+			reporter(state, functionNode.toString(), ...sourceIndices(functionNode));
 		}
 
 		/**
@@ -187,7 +187,7 @@ const rule = (primary) => {
 			reporter(
 				state,
 				componentValues.map((x) => x.toString()).join(''),
-				...startAndEndIndex(componentValues),
+				...sourceIndices(componentValues),
 			);
 		}
 
@@ -271,40 +271,6 @@ const rule = (primary) => {
 	};
 };
 
-/**
- * A recursive function that returns the start and end boundaries of a node.
- *
- * @template {import('@csstools/css-tokenizer').CSSToken} T
- * @param {Array<{ tokens(): Array<T> }> | { tokens(): Array<T> }} node
- * @returns {[number, number]}
- */
-function startAndEndIndex(node) {
-	if (Array.isArray(node)) {
-		const nodeStart = node[0];
-
-		if (!nodeStart) return [0, 0];
-
-		const nodeEnd = node[node.length - 1] || nodeStart;
-
-		const [startA] = startAndEndIndex(nodeStart);
-		const [, endB] = startAndEndIndex(nodeEnd);
-
-		return [startA, endB];
-	}
-
-	const tokens = node.tokens();
-
-	const firstToken = tokens[0];
-	const lastToken = tokens[tokens.length - 1];
-
-	if (!firstToken || !lastToken) return [0, 0];
-
-	const start = firstToken[2];
-	const end = lastToken[3];
-
-	return [start, end];
-}
-
 rule.ruleName = ruleName;
 rule.messages = messages;
 rule.meta = meta;

diff --git a/lib/rules/media-feature-range-notation/index.js b/lib/rules/media-feature-range-notation/index.js
@@ -1,5 +1,7 @@
 'use strict';
 
+const { TokenType } = require('@csstools/css-tokenizer');
+const { TokenNode, sourceIndices } = require('@csstools/css-parser-algorithms');
 const {
 	MediaFeatureName,
 	MediaFeatureRangeNameValue,
@@ -8,8 +10,6 @@ const {
 	isMediaFeatureRange,
 	isMediaQueryInvalid,
 } = require('@csstools/media-query-list-parser');
-const { TokenNode } = require('@csstools/css-parser-algorithms');
-const { TokenType } = require('@csstools/css-tokenizer');
 
 const atRuleParamIndex = require('../../utils/atRuleParamIndex');
 const parseMediaQuery = require('../../utils/parseMediaQuery');
@@ -94,17 +94,7 @@ const rule = (primary, _secondaryOptions, context) => {
 						return;
 					}
 
-					const tokens = node.tokens();
-					const firstToken = tokens[0];
-					const lastToken = tokens[tokens.length - 1];
-
-					let startIndex = 0;
-					let endIndex = atRule.params.length;
-
-					if (firstToken && lastToken) {
-						startIndex = firstToken[2];
-						endIndex = lastToken[3];
-					}
+					const [startIndex, endIndex] = sourceIndices(node);
 
 					const atRuleIndex = atRuleParamIndex(atRule);
 

diff --git a/lib/rules/media-query-no-invalid/index.js b/lib/rules/media-query-no-invalid/index.js
@@ -1,5 +1,6 @@
 'use strict';
 
+const { sourceIndices } = require('@csstools/css-parser-algorithms');
 const {
 	isMediaQueryInvalid,
 	isGeneralEnclosed,
@@ -116,7 +117,7 @@ const rule = (primary) => {
 			const atRuleParamIndexValue = atRuleParamIndex(atRule);
 
 			invalidNodes.forEach((invalidNode) => {
-				const [start, end] = startAndEndIndex(invalidNode);
+				const [start, end] = sourceIndices(invalidNode);
 
 				report({
 					message: messages.rejected,
@@ -132,26 +133,6 @@ const rule = (primary) => {
 	};
 };
 
-/**
- * A function that returns the start and end boundaries of a node.
- *
- * @param {{ tokens(): Array<import('@csstools/css-tokenizer').CSSToken> }} node
- * @returns {[number, number]}
- */
-function startAndEndIndex(node) {
-	const tokens = node.tokens();
-
-	const firstToken = tokens[0];
-	const lastToken = tokens[tokens.length - 1];
-
-	if (!firstToken || !lastToken) return [0, 0];
-
-	const start = firstToken[2];
-	const end = lastToken[3];
-
-	return [start, end];
-}
-
 rule.ruleName = ruleName;
 rule.messages = messages;
 rule.meta = meta;

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -130,10 +130,10 @@
     ]
   },
   "dependencies": {
-    "@csstools/css-parser-algorithms": "^2.2.0",
+    "@csstools/css-parser-algorithms": "^2.3.0",
     "@csstools/css-tokenizer": "^2.1.1",
-    "@csstools/media-query-list-parser": "^2.1.1",
-    "@csstools/selector-specificity": "^2.2.0",
+    "@csstools/media-query-list-parser": "^2.1.2",
+    "@csstools/selector-specificity": "^3.0.0",
     "balanced-match": "^2.0.0",
     "colord": "^2.9.3",
     "cosmiconfig": "^8.2.0",