@eslint/css-tree 3.5.2 → 3.5.4

package/dist/version.cjs

@@ -1 +1 @@
-module.exports = "3.5.2";
+module.exports = "3.5.4";

package/dist/version.js

@@ -1 +1 @@
-export const version = "3.5.2";
+export const version = "3.5.4";

package/lib/index.d.ts

@@ -1284,7 +1284,7 @@ export class TokenStream {
     lookupOffset(offset: number): number;
 
     /**
-     * Skips whitespace and comments and returns the starting index (inclusive) of the `idx`-th non-whitespace/comment token in the `TokenStream`.
+     * Returns the starting index (inclusive) of the `idx`-th non-whitespace/comment token in the `TokenStream`. This method skips whitespace and comment tokens until it finds the specified non-whitespace/comment token.
      *
      * @param index - The index of the non-whitespace/comment token to look up (starting from 0).
      * @returns The starting index of the `idx`-th non-whitespace/comment token, or `EOF` if the index is out of bounds or if the end of the stream is reached before the specified token is found.
@@ -1608,6 +1608,14 @@ export interface ParseFunction {
  */
 export const parse: ParseFunction;
 
+/**
+ * Represents a function that reads a sequence of CSS tokens and returns a list of nodes.
+ *
+ * @param recognizer - A recognizer instance to determine node boundaries.
+ * @returns A list of parsed nodes.
+ */
+export type ReadSequenceFunction = (this: ParserContext, recognizer: Recognizer) => List<CssNode>;
+
 // ----------------------------------------------------------
 // Generator
 // https://github.com/csstree/csstree/tree/master/lib/generator
@@ -1707,8 +1715,7 @@ export interface WalkContext {
     break: symbol;
 
     /**
-     * Prevents the current node from being iterated. No visitor function will
-     * be invoked for its properties or children nodes. This value only affects
+     * Prevents the current node from being iterated. No visitor function will be invoked for its properties or children nodes. This value only affects
      * the `enter` visitor; the `leave` visitor is invoked after iterating
      * over all node's properties and children.
      */
@@ -2415,12 +2422,11 @@ export interface LexerMatchResult {
 
 type ConsumerFunction = (this: ParserContext, ...args: unknown[]) => CssNode;
 
-// https://github.com/csstree/csstree/tree/master/lib/syntax/scope
 /**
  * Recognizer is responsible for identifying specific patterns or constructs within the CSS syntax.
  * It provides methods to interpret and handle these constructs during parsing.
+ * @see https://github.com/csstree/csstree/blob/master/lib/syntax/scope
  */
-// FIXME
 interface Recognizer {
     /**
      * Retrieves a node based on the provided parsing context.
@@ -2428,16 +2434,19 @@ interface Recognizer {
      * @param context - The parsing context, which contains relevant state and configuration for the parser.
      * @returns A function that, when executed, produces a `CssNode`.
      */
-    getNode(context: ParserContext): (this: ParserContext) => CssNode;
+    getNode(this: ParserContext): CssNode;
+
+    /**
+     * Handles whitespace between CSS selectors during parsing.
+     * Ensures that whitespace is correctly interpreted as a descendant combinator.
+     *
+     * @param next - The next node or token in the parsing sequence.
+     * @param children - The list of parsed nodes, which will be modified to include a `Combinator` node if applicable.
+     */
+    onWhitespace?(this: ParserContext, next: CssNode | null, children: List<CssNode>): void;
 
-    // /**
-    //  * Handles whitespace between CSS selectors during parsing.
-    //  * Ensures that whitespace is correctly interpreted as a descendant combinator.
-    //  *
-    //  * @param next - The next node or token in the parsing sequence.
-    //  * @param children - The list of parsed nodes, which will be modified to include a `Combinator` node if applicable.
-    //  */
-    // onWhiteSpace?(next: CssNode | null, children: CssNodeList): void;
+    // any number of other properties
+    [key:string]: any;
 }
 
 /**
@@ -2468,11 +2477,8 @@ interface Parser {
 
     /**
      * Reads a sequence of CSS nodes based on the provided recognizer.
-     *
-     * @param recognizer - A recognizer instance to determine node boundaries.
-     * @returns A list of parsed `CssNode` objects.
      */
-    readSequence(this: ParserContext, recognizer: Recognizer): List<CssNode>;
+    readSequence: ReadSequenceFunction;
 
     /**
      * Consumes input until the end of a balance context is reached.
@@ -2674,6 +2680,14 @@ interface Parser {
     error: (this: ParserContext, message: string, offset: number) => void;
 }
 
+// AtruleParseConfig type based on the structure of files in lib/syntax/atrule/
+interface AtruleParseConfig {
+    parse: {
+        prelude?: ((this: ParserContext) => List<CssNode>) | null;
+        block?: ((this: ParserContext, nested?: boolean) => CssNode) | null;
+    };
+}
+
 // https://github.com/csstree/csstree/blob/9de5189fadd6fb4e3a149eec0e80d6ed0d0541e5/lib/parser/create.js#L53-L80
 type ParseConfig = {
     context: Record<string, ConsumerFunction | undefined>;
@@ -2732,11 +2746,11 @@ export interface SyntaxConfig<T extends CssNodeCommon = CssNodeCommon> {
     types: Record<string, string>;
     properties: Record<string, string>;
     atrules: Record<string, AtruleSyntax>;
-    node: Record<string, NodeSyntaxConfig<T>>;
-    atrule: Record<string, { parse: ConsumerFunction; }>;
+    node: Record<string, Partial<NodeSyntaxConfig<T>>>;
+    atrule: Record<string, AtruleParseConfig>;
     pseudo: Record<string, { parse: ConsumerFunction; }>;
-    scope: Record<string, Recognizer>;
-    features: Record<string, Recognizer>;
+    scope: Record<string, Partial<Recognizer>>;
+    features: Record<string, Partial<Recognizer>>;
     parseContext: ParseContext;
     tokenize: TokenizeFunction;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eslint/css-tree",
-  "version": "3.5.2",
+  "version": "3.5.4",
   "description": "A tool set for CSS: fast detailed parser (CSS → AST), walker (AST traversal), generator (AST → CSS) and lexer (validation and matching) based on specs and browser implementations",
   "author": "Roman Dvornov <rdvornov@gmail.com> (https://github.com/lahmatiy)",
   "license": "MIT",