@jesscss/css-parser 1.0.8-alpha.6 → 2.0.0-alpha.2

package/lib/cssTokens.d.ts

@@ -1,14 +1,15 @@
-import { rawTokenConfig } from './util';
+import { LexerType } from './util/index.js';
 /**
  * references:
  * https://github.com/antlr/grammars-v4/blob/master/css3/css3.g4
  * https://www.lifewire.com/css2-vs-css3-3466978
  * https://www.w3.org/TR/css-syntax-3/
  *
- * Fragments and Tokens must be defined in order
- * ({{references}} must follow definitions)
+ * @todo
+ * XRegExp should accept an object rather than an array of arrays,
+ * which would make extending easier.
  */
-export declare const Fragments: [string, string][];
+export declare const rawCssFragments: () => readonly [readonly ["newline", "\\n|\\r\\n?|\\f"], readonly ["whitespace", "[ ]|\\t|{{newline}}"], readonly ["sepws", "(?:[ ]|\\t)*{{newline}}|(?:[ ]|\\t)+"], readonly ["ws", "{{whitespace}}+"], readonly ["comment", "\\/\\*[^*]*\\*+(?:[^/*][^*]*\\*+)*\\/"], readonly ["hex", "[\\da-fA-F]"], readonly ["unicode", "\\\\{{hex}}{1,6}{{whitespace}}?"], readonly ["escape", "{{unicode}}|\\\\[^\\r\\n\\f0-9a-fA-F]"], readonly ["nonascii", "[\\u0240-\\uffff]"], readonly ["nmstart", "[_a-zA-Z]|{{nonascii}}|{{escape}}"], readonly ["nmchar", "[_a-zA-Z0-9-]|{{nonascii}}|{{escape}}"], readonly ["ident", "-?{{nmstart}}{{nmchar}}*"], readonly ["unit", "(?:[a-zA-Z]|{{nonascii}}|{{escape}})+"], readonly ["string1", "\\\"(\\\\\"|\\\\{{newline}}|[^\\n\\r\\f\\\"]|{{newline}}|{{escape}})*\\\""], readonly ["string2", "\\'(\\\\'|\\\\{{newline}}|[^\\n\\r\\f\\']|{{newline}}|{{escape}})*\\'"], readonly ["integer", "[+-]?\\d+"], readonly ["number", "(?:\\d*\\.\\d+(?:[eE][+-]\\d+)?|\\d+(?:[eE][+-]\\d+))"], readonly ["wsorcomment", "({{ws}})|({{comment}})"]];
 /**
  * When bound to a Regular Expression, it will aggregrate capture groups onto the payload
  */
@@ -16,5 +17,538 @@ export declare function groupCapture(this: RegExp, text: string, startOffset: nu
 /**
  * Anything that is not 'BlockMarker' will be parsed as a generic 'Value',
  * so 'Value' can be considered `!BlockMarker`
+ *
+ * @todo Change to Map implementation? May allow easier replacement of
+ * tokens, in extended parsers, as well as easier TokenMap.
  */
-export declare const Tokens: rawTokenConfig[];
+export declare const rawCssTokens: () => {
+    readonly modes: {
+        readonly Default: readonly [{
+            readonly name: "Value";
+            readonly pattern: LexerType.NA;
+        }, {
+            readonly name: "NonIdent";
+            readonly pattern: LexerType.NA;
+        }, {
+            readonly name: "AtName";
+            readonly pattern: LexerType.NA;
+        }, {
+            readonly name: "MfLt";
+            readonly pattern: LexerType.NA;
+        }, {
+            readonly name: "MfGt";
+            readonly pattern: LexerType.NA;
+        }, {
+            readonly name: "Unknown";
+            readonly pattern: RegExp;
+        }, {
+            readonly name: "BlockMarker";
+            readonly pattern: LexerType.NA;
+        }, {
+            readonly name: "ListMarker";
+            readonly pattern: LexerType.NA;
+        }, {
+            readonly name: "CompareOperator";
+            readonly pattern: LexerType.NA;
+        }, {
+            readonly name: "Slash";
+            readonly pattern: LexerType.NA;
+        }, {
+            readonly name: "Selector";
+            readonly pattern: LexerType.NA;
+        }, {
+            readonly name: "Combinator";
+            readonly pattern: LexerType.NA;
+        }, {
+            readonly name: "Color";
+            readonly pattern: LexerType.NA;
+        }, {
+            readonly name: "FunctionStart";
+            readonly pattern: LexerType.NA;
+        }, {
+            readonly name: "FunctionalPseudoClass";
+            readonly pattern: LexerType.NA;
+        }, {
+            readonly name: "Assign";
+            readonly pattern: LexerType.NA;
+        }, {
+            readonly name: "QuoteStart";
+            readonly pattern: LexerType.NA;
+        }, {
+            readonly name: "Gt";
+            readonly pattern: RegExp;
+            readonly categories: readonly ["CompareOperator", "Combinator", "MfGt"];
+        }, {
+            readonly name: "Lt";
+            readonly pattern: RegExp;
+            readonly categories: readonly ["CompareOperator", "MfLt"];
+        }, {
+            readonly name: "GtEq";
+            readonly pattern: RegExp;
+            readonly categories: readonly ["CompareOperator", "MfGt"];
+        }, {
+            readonly name: "LtEq";
+            readonly pattern: RegExp;
+            readonly categories: readonly ["CompareOperator", "MfGt"];
+        }, {
+            readonly name: "LCurly";
+            readonly pattern: RegExp;
+            readonly categories: readonly ["BlockMarker"];
+        }, {
+            readonly name: "RCurly";
+            readonly pattern: RegExp;
+            readonly categories: readonly ["BlockMarker"];
+        }, {
+            readonly name: "LParen";
+            readonly pattern: RegExp;
+            readonly categories: readonly ["BlockMarker"];
+        }, {
+            readonly name: "RParen";
+            readonly pattern: RegExp;
+            readonly categories: readonly ["BlockMarker"];
+        }, {
+            readonly name: "LSquare";
+            readonly pattern: RegExp;
+            readonly categories: readonly ["BlockMarker"];
+        }, {
+            readonly name: "RSquare";
+            readonly pattern: RegExp;
+            readonly categories: readonly ["BlockMarker"];
+        }, {
+            readonly name: "Semi";
+            readonly pattern: RegExp;
+            readonly categories: readonly ["BlockMarker"];
+        }, {
+            readonly name: "AdditionOperator";
+            readonly pattern: LexerType.NA;
+        }, {
+            readonly name: "MultiplicationOperator";
+            readonly pattern: LexerType.NA;
+        }, {
+            readonly name: "Plus";
+            readonly pattern: RegExp;
+            readonly categories: readonly ["AdditionOperator", "Combinator"];
+        }, {
+            readonly name: "Minus";
+            readonly pattern: RegExp;
+            readonly categories: readonly ["AdditionOperator"];
+        }, {
+            readonly name: "Divide";
+            readonly pattern: RegExp;
+            readonly categories: readonly ["MultiplicationOperator", "Slash"];
+        }, {
+            readonly name: "Comma";
+            readonly pattern: RegExp;
+            readonly categories: readonly ["BlockMarker"];
+        }, {
+            readonly name: "Colon";
+            readonly pattern: RegExp;
+            readonly categories: readonly ["BlockMarker", "Assign"];
+        }, {
+            readonly name: "AttrMatchOperator";
+            readonly pattern: LexerType.NA;
+        }, {
+            readonly name: "Eq";
+            readonly pattern: RegExp;
+            readonly categories: readonly ["CompareOperator", "AttrMatchOperator"];
+        }, {
+            readonly name: "Star";
+            readonly pattern: RegExp;
+            readonly categories: readonly ["MultiplicationOperator"];
+        }, {
+            readonly name: "Tilde";
+            readonly pattern: RegExp;
+            readonly categories: readonly ["Combinator"];
+        }, {
+            readonly name: "Pipe";
+            readonly pattern: RegExp;
+            readonly categories: readonly ["Combinator"];
+        }, {
+            readonly name: "Column";
+            readonly pattern: RegExp;
+            readonly categories: readonly ["Combinator"];
+        }, {
+            readonly name: "AttrMatch";
+            readonly pattern: RegExp;
+            readonly categories: readonly ["AttrMatchOperator"];
+        }, {
+            readonly name: "Ident";
+            readonly pattern: LexerType.NA;
+        }, {
+            readonly name: "PlainIdent";
+            readonly pattern: "{{ident}}";
+            readonly categories: readonly ["Ident"];
+        }, {
+            readonly name: "LegacyPropIdent";
+            readonly pattern: "(?:\\*|_){{ident}}";
+        }, {
+            readonly name: "CustomProperty";
+            readonly pattern: "--{{ident}}";
+            readonly categories: readonly ["BlockMarker"];
+        }, {
+            readonly name: "CDOToken";
+            readonly pattern: RegExp;
+            readonly group: LexerType.SKIPPED;
+        }, {
+            readonly name: "CDCToken";
+            readonly pattern: RegExp;
+            readonly group: LexerType.SKIPPED;
+        }, {
+            readonly name: "UnicodeBOM";
+            readonly pattern: RegExp;
+            readonly group: LexerType.SKIPPED;
+        }, {
+            readonly name: "AttrFlag";
+            readonly pattern: RegExp;
+            readonly longer_alt: "PlainIdent";
+            readonly categories: readonly ["Ident"];
+        }, {
+            readonly name: "MathConstant";
+            readonly pattern: RegExp;
+            readonly longer_alt: "PlainIdent";
+            readonly categories: readonly ["Ident"];
+        }, {
+            readonly name: "Only";
+            readonly pattern: RegExp;
+            readonly longer_alt: "PlainIdent";
+            readonly categories: readonly ["Ident"];
+        }, {
+            readonly name: "Screen";
+            readonly pattern: RegExp;
+            readonly longer_alt: "PlainIdent";
+            readonly categories: readonly ["Ident"];
+        }, {
+            readonly name: "Print";
+            readonly pattern: RegExp;
+            readonly longer_alt: "PlainIdent";
+            readonly categories: readonly ["Ident"];
+        }, {
+            readonly name: "All";
+            readonly pattern: RegExp;
+            readonly longer_alt: "PlainIdent";
+            readonly categories: readonly ["Ident"];
+        }, {
+            readonly name: "GenericFunctionStart";
+            readonly pattern: "{{ident}}\\(";
+            readonly categories: readonly ["BlockMarker", "FunctionStart"];
+        }, {
+            readonly name: "And";
+            readonly pattern: RegExp;
+            readonly longer_alt: "PlainIdent";
+            readonly categories: readonly ["Ident"];
+        }, {
+            readonly name: "Or";
+            readonly pattern: RegExp;
+            readonly longer_alt: "PlainIdent";
+            readonly categories: readonly ["Ident"];
+        }, {
+            readonly name: "Layer";
+            readonly pattern: RegExp;
+            readonly categories: readonly ["BlockMarker", "FunctionStart"];
+        }, {
+            readonly name: "Supports";
+            readonly pattern: RegExp;
+            readonly categories: readonly ["BlockMarker", "FunctionStart"];
+        }, {
+            readonly name: "Var";
+            readonly pattern: RegExp;
+            readonly categories: readonly ["BlockMarker", "FunctionStart"];
+        }, {
+            readonly name: "Calc";
+            readonly pattern: RegExp;
+            readonly categories: readonly ["BlockMarker", "FunctionStart"];
+        }, {
+            readonly name: "From";
+            readonly pattern: RegExp;
+            readonly longer_alt: "PlainIdent";
+            readonly categories: readonly ["Ident"];
+        }, {
+            readonly name: "To";
+            readonly pattern: RegExp;
+            readonly longer_alt: "PlainIdent";
+            readonly categories: readonly ["Ident"];
+        }, {
+            readonly name: "AtKeyword";
+            readonly pattern: "@{{ident}}";
+            readonly categories: readonly ["BlockMarker", "AtName"];
+        }, {
+            readonly name: "UrlStart";
+            readonly pattern: RegExp;
+            readonly push_mode: "Url";
+            readonly categories: readonly ["BlockMarker", "FunctionStart"];
+        }, {
+            readonly name: "LegacyMSFilter";
+            readonly pattern: RegExp;
+            readonly categories: readonly ["BlockMarker"];
+        }, {
+            readonly name: "SingleQuoteStart";
+            readonly pattern: RegExp;
+            readonly push_mode: "SingleQuoteString";
+            readonly categories: readonly ["BlockMarker", "QuoteStart"];
+        }, {
+            readonly name: "DoubleQuoteStart";
+            readonly pattern: RegExp;
+            readonly push_mode: "DoubleQuoteString";
+            readonly categories: readonly ["BlockMarker", "QuoteStart"];
+        }, {
+            readonly name: "Important";
+            readonly pattern: "!(?:{{ws}}|{{comment}})*important";
+            readonly categories: readonly ["BlockMarker"];
+        }, {
+            readonly name: "AtImport";
+            readonly pattern: RegExp;
+            readonly longer_alt: "AtKeyword";
+            readonly categories: readonly ["BlockMarker", "AtName"];
+        }, {
+            readonly name: "AtMedia";
+            readonly pattern: RegExp;
+            readonly longer_alt: "AtKeyword";
+            readonly categories: readonly ["BlockMarker", "AtName"];
+        }, {
+            readonly name: "AtSupports";
+            readonly pattern: RegExp;
+            readonly longer_alt: "AtKeyword";
+            readonly categories: readonly ["BlockMarker", "AtName"];
+        }, {
+            readonly name: "AtLayer";
+            readonly pattern: RegExp;
+            readonly longer_alt: "AtKeyword";
+            readonly categories: readonly ["BlockMarker", "AtName"];
+        }, {
+            readonly name: "AtContainer";
+            readonly pattern: RegExp;
+            readonly longer_alt: "AtKeyword";
+            readonly categories: readonly ["BlockMarker", "AtName"];
+        }, {
+            readonly name: "AtScope";
+            readonly pattern: RegExp;
+            readonly longer_alt: "AtKeyword";
+            readonly categories: readonly ["BlockMarker", "AtName"];
+        }, {
+            readonly name: "AtDocument";
+            readonly pattern: RegExp;
+            readonly longer_alt: "AtKeyword";
+            readonly categories: readonly ["BlockMarker", "AtName"];
+        }, {
+            readonly name: "AtPage";
+            readonly pattern: RegExp;
+            readonly longer_alt: "AtKeyword";
+            readonly categories: readonly ["BlockMarker", "AtName"];
+        }, {
+            readonly name: "AtFontFace";
+            readonly pattern: RegExp;
+            readonly categories: readonly ["BlockMarker", "AtName"];
+        }, {
+            readonly name: "AtKeyframes";
+            readonly pattern: RegExp;
+            readonly longer_alt: "AtKeyword";
+            readonly categories: readonly ["BlockMarker", "AtName"];
+        }, {
+            readonly name: "AtNested";
+            readonly pattern: RegExp;
+            readonly longer_alt: "AtKeyword";
+            readonly categories: readonly ["BlockMarker", "AtName"];
+        }, {
+            readonly name: "AtNonNested";
+            readonly pattern: RegExp;
+            readonly longer_alt: "AtKeyword";
+            readonly categories: readonly ["BlockMarker", "AtName"];
+        }, {
+            readonly name: "Charset";
+            readonly pattern: "@charset{{ws}}?(?:{{string1}}|{{string2}});";
+        }, {
+            readonly name: "UnicodeRange";
+            readonly pattern: RegExp;
+        }, {
+            readonly name: "Ampersand";
+            readonly pattern: RegExp;
+            readonly categories: readonly ["Selector"];
+        }, {
+            readonly name: "DotName";
+            readonly pattern: "\\.{{ident}}";
+            readonly categories: readonly ["Selector"];
+        }, {
+            readonly name: "HashName";
+            readonly pattern: "#{{ident}}";
+            readonly categories: readonly ["Selector"];
+        }, {
+            readonly name: "NthPseudoClass";
+            readonly pattern: RegExp;
+            readonly categories: readonly ["BlockMarker", "FunctionalPseudoClass"];
+        }, {
+            readonly name: "SelectorPseudoClass";
+            readonly pattern: RegExp;
+            readonly categories: readonly ["BlockMarker", "FunctionalPseudoClass"];
+        }, {
+            readonly name: "PagePseudoClassKeywords";
+            readonly pattern: RegExp;
+            readonly categories: readonly ["Ident"];
+            readonly longer_alt: "PlainIdent";
+        }, {
+            readonly name: "NthOdd";
+            readonly pattern: RegExp;
+            readonly longer_alt: "PlainIdent";
+            readonly categories: readonly ["Ident"];
+        }, {
+            readonly name: "NthEven";
+            readonly pattern: RegExp;
+            readonly longer_alt: "PlainIdent";
+            readonly categories: readonly ["Ident"];
+        }, {
+            readonly name: "Of";
+            readonly pattern: RegExp;
+            readonly longer_alt: "PlainIdent";
+            readonly categories: readonly ["Ident"];
+        }, {
+            readonly name: "ColorIntStart";
+            readonly pattern: RegExp;
+            readonly categories: readonly ["Color"];
+        }, {
+            readonly name: "ColorIdentStart";
+            readonly pattern: RegExp;
+            readonly longer_alt: "HashName";
+            readonly categories: readonly ["Color", "Selector"];
+        }, {
+            readonly name: "Number";
+            readonly pattern: LexerType.NA;
+        }, {
+            readonly name: "Dimension";
+            readonly pattern: LexerType.NA;
+        }, {
+            readonly name: "Integer";
+            readonly pattern: LexerType.NA;
+        }, {
+            readonly name: "Signed";
+            readonly pattern: LexerType.NA;
+        }, {
+            readonly name: "DimensionNum";
+            readonly pattern: readonly ["({{number}})({{unit}}|%)", typeof groupCapture];
+            readonly start_chars_hint: readonly ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "."];
+            readonly line_breaks: false;
+            readonly categories: readonly ["Dimension", "Selector"];
+        }, {
+            readonly name: "DimensionInt";
+            readonly pattern: readonly ["({{integer}})({{unit}}|%)", typeof groupCapture];
+            readonly start_chars_hint: readonly ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9"];
+            readonly line_breaks: false;
+            readonly categories: readonly ["Dimension", "Integer", "Selector"];
+        }, {
+            readonly name: "SignedDimensionNum";
+            readonly pattern: readonly ["([+-]{{number}})({{unit}}|%)", typeof groupCapture];
+            readonly start_chars_hint: readonly ["-", "+"];
+            readonly line_breaks: false;
+            readonly categories: readonly ["Dimension", "Signed"];
+        }, {
+            readonly name: "SignedDimensionInt";
+            readonly pattern: readonly ["([+-]{{integer}})({{unit}}|%)", typeof groupCapture];
+            readonly start_chars_hint: readonly ["-", "+"];
+            readonly line_breaks: false;
+            readonly categories: readonly ["Dimension", "Integer", "Signed"];
+        }, {
+            readonly name: "SignedInt";
+            readonly pattern: RegExp;
+            readonly longer_alt: "SignedDimensionInt";
+            readonly categories: readonly ["Integer", "Number", "Signed"];
+        }, {
+            readonly name: "UnsignedInt";
+            readonly pattern: RegExp;
+            readonly longer_alt: "DimensionInt";
+            readonly categories: readonly ["Integer", "Number"];
+        }, {
+            readonly name: "SignedNum";
+            readonly pattern: "[+-]{{number}}";
+            readonly longer_alt: "SignedDimensionNum";
+            readonly categories: readonly ["Integer", "Number", "Signed"];
+        }, {
+            readonly name: "UnsignedNum";
+            readonly pattern: "{{number}}";
+            readonly longer_alt: "DimensionNum";
+            readonly categories: readonly ["Number"];
+        }, {
+            readonly name: "NthSignedDimension";
+            readonly pattern: RegExp;
+            readonly longer_alt: "SignedDimensionInt";
+            readonly line_breaks: false;
+            readonly categories: readonly ["Dimension", "Signed"];
+        }, {
+            readonly name: "NthUnsignedDimension";
+            readonly pattern: RegExp;
+            readonly longer_alt: "DimensionNum";
+            readonly line_breaks: false;
+            readonly categories: readonly ["Dimension"];
+        }, {
+            readonly name: "NthSignedPlus";
+            readonly pattern: RegExp;
+            readonly line_breaks: false;
+        }, {
+            readonly name: "NthIdent";
+            readonly pattern: "-?n(?!{{nmchar}})";
+            readonly longer_alt: "PlainIdent";
+            readonly line_breaks: false;
+            readonly categories: readonly ["Ident"];
+        }, {
+            readonly name: "Not";
+            readonly pattern: RegExp;
+            readonly longer_alt: "PlainIdent";
+            readonly categories: readonly ["Ident"];
+        }, {
+            readonly name: "WS";
+            readonly pattern: "{{ws}}";
+            readonly line_breaks: true;
+            readonly label: "Skipped";
+        }, {
+            readonly name: "Comment";
+            readonly pattern: "{{comment}}";
+            readonly line_breaks: true;
+            readonly label: "Skipped";
+        }];
+        readonly SingleQuoteString: readonly [{
+            readonly name: "SingleQuoteStringContents";
+            readonly pattern: "(?:[\\u0000-\\u0026\\u0028-\\u005B\\u005D-\\uFFFF]|\\\\'|\\\\{{newline}}|{{newline}}|{{escape}})+";
+        }, {
+            readonly name: "SingleQuoteEnd";
+            readonly pattern: RegExp;
+            readonly pop_mode: true;
+        }];
+        readonly DoubleQuoteString: readonly [{
+            readonly name: "DoubleQuoteStringContents";
+            readonly pattern: "(?:[\\u0000-\\u0021\\u0023-\\u005B\\u005D-\\uFFFF]|\\\\\"|\\\\{{newline}}|{{newline}}|{{escape}})+";
+        }, {
+            readonly name: "DoubleQuoteEnd";
+            readonly pattern: RegExp;
+            readonly pop_mode: true;
+        }];
+        readonly Url: readonly [{
+            readonly name: "NonQuotedUrl";
+            /**
+             * Equivalent to: /[^)(\'"]+/ but a-lot less clear :(
+             * @see https://chevrotain.io/docs/guide/resolving_lexer_errors.html#COMPLEMENT
+             *
+             * Note that:
+             *  - "\u0022" === `"`
+             *  - "\u0027" === `'`
+             *  - "\u0028" === `(`
+             *  - "\u0029" === `)`
+             *  - "\u005C" === `\`
+             */
+            readonly pattern: "(?:[\\u0000-\\u0021\\u0023-\\u0026\\u002A-\\u005B\\u005D-\\uFFFF]|{{escape}})+";
+        }, {
+            readonly name: "UrlEnd";
+            readonly pattern: RegExp;
+            readonly pop_mode: true;
+        }, "SingleQuoteStart", "DoubleQuoteStart", "WS"];
+    };
+    readonly defaultMode: "Default";
+};
+type TokenModes = ReturnType<typeof rawCssTokens>['modes'];
+export type TokenNameMap<T extends readonly any[]> = {
+    [P in keyof T]: T[P] extends {
+        name: string;
+    } ? T[P]['name'] : T[P];
+};
+export type TokenNames<T extends readonly any[]> = TokenNameMap<T>[number];
+/** Join all modes to get strong indexing */
+export type CssTokenType = TokenNames<TokenModes[keyof TokenModes]>;
+export declare const cssFragments: Record<string, RegExp>;
+export declare const cssLexer: import("./index.js").ILexer;
+export {};