@markuplint/types 3.0.0-dev.25 → 3.0.0-dev.300

package/lib/token/token-collection.js

@@ -1,16 +1,15 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TokenCollection = void 0;
-const match_result_1 = require("../match-result");
-const token_1 = require("./token");
-class TokenCollection extends Array {
-    static fromPatterns(value, patterns, typeOptions) {
-        const origin = typeof value === 'string' ? value : value.origin;
+import { matched, unmatched } from '../match-result.js';
+import { Token } from './token.js';
+export class TokenCollection extends Array {
+    static fromPatterns(value, patterns, 
+    // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+    typeOptions) {
+        const originalValue = typeof value === 'string' ? value : value.originalValue;
         let strings = typeof value === 'string' ? value : value.value;
         let cumulativeOffset = typeof value === 'string' ? 0 : value.offset;
         const tokens = [];
         function addToken(tokenValue) {
-            const token = new token_1.Token(tokenValue, cumulativeOffset, origin);
+            const token = new Token(tokenValue, cumulativeOffset, originalValue);
             tokens.push(token);
             strings = strings.slice(tokenValue.length);
             cumulativeOffset += tokenValue.length;
@@ -31,7 +30,7 @@ class TokenCollection extends Array {
                         value = strings.slice(res.index + res[0].length);
                     }
                     else {
-                        value = res[0] || '';
+                        value = res[0] ?? '';
                     }
                 }
                 const token = addToken(value);
@@ -41,7 +40,7 @@ class TokenCollection extends Array {
             if (isBroken) {
                 addToken(strings);
             }
-        } while ((typeOptions === null || typeOptions === void 0 ? void 0 : typeOptions.repeat) && strings);
+        } while (typeOptions?.repeat && strings);
         if (strings) {
             addToken(strings);
         }
@@ -50,15 +49,17 @@ class TokenCollection extends Array {
     static get [Symbol.species]() {
         return Array;
     }
-    constructor(value, typeOptions) {
+    constructor(value, 
+    // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+    typeOptions) {
         super();
-        this.disallowToSurroundBySpaces = (typeOptions === null || typeOptions === void 0 ? void 0 : typeOptions.disallowToSurroundBySpaces) || false;
-        this.allowEmpty = (typeOptions === null || typeOptions === void 0 ? void 0 : typeOptions.allowEmpty) || true;
-        this.ordered = (typeOptions === null || typeOptions === void 0 ? void 0 : typeOptions.ordered) || false;
-        this.unique = (typeOptions === null || typeOptions === void 0 ? void 0 : typeOptions.unique) || false;
-        this.caseInsensitive = (typeOptions === null || typeOptions === void 0 ? void 0 : typeOptions.caseInsensitive) || true;
-        this.number = typeOptions === null || typeOptions === void 0 ? void 0 : typeOptions.number;
-        this.separator = (typeOptions === null || typeOptions === void 0 ? void 0 : typeOptions.separator) || 'space';
+        this.disallowToSurroundBySpaces = typeOptions?.disallowToSurroundBySpaces ?? false;
+        this.allowEmpty = typeOptions?.allowEmpty ?? true;
+        this.ordered = typeOptions?.ordered ?? false;
+        this.unique = typeOptions?.unique ?? false;
+        this.caseInsensitive = typeOptions?.caseInsensitive ?? true;
+        this.number = typeOptions?.number;
+        this.separator = typeOptions?.separator ?? 'space';
         if (typeof value === 'number') {
             this.length = value;
             return;
@@ -70,12 +71,12 @@ class TokenCollection extends Array {
         if (this.separator === 'comma') {
             separators.push(',');
         }
-        if (typeOptions === null || typeOptions === void 0 ? void 0 : typeOptions.specificSeparator) {
-            if (Array.isArray(typeOptions.specificSeparator)) {
-                separators.push(...typeOptions.specificSeparator);
+        if (typeOptions?.specificSeparator != null) {
+            if (typeof typeOptions.specificSeparator === 'string') {
+                separators.push(typeOptions.specificSeparator);
             }
             else {
-                separators.push(typeOptions.specificSeparator);
+                separators.push(...typeOptions.specificSeparator);
             }
         }
         const chars = value.split('');
@@ -88,10 +89,11 @@ class TokenCollection extends Array {
                 continue;
             }
             const lastChar = last[0];
-            if (!separators.includes(char) &&
-                !separators.includes(last[0]) &&
-                ((token_1.Token.whitespace.includes(lastChar) && token_1.Token.whitespace.includes(char)) ||
-                    (!token_1.Token.whitespace.includes(lastChar) && !token_1.Token.whitespace.includes(char)))) {
+            if (lastChar &&
+                !separators.includes(char) &&
+                !separators.includes(lastChar) &&
+                ((Token.whitespace.includes(lastChar) && Token.whitespace.includes(char)) ||
+                    (!Token.whitespace.includes(lastChar) && !Token.whitespace.includes(char)))) {
                 values.push(last + char);
             }
             else {
@@ -101,7 +103,7 @@ class TokenCollection extends Array {
         }
         let offset = 0;
         values.forEach(v => {
-            const token = new token_1.Token(v, offset, value, separators);
+            const token = new Token(v, offset, value, separators);
             this.push(token);
             offset += v.length;
         });
@@ -111,7 +113,6 @@ class TokenCollection extends Array {
         return value;
     }
     check(options = {}) {
-        var _c;
         const { expects, ref } = options;
         if (this.disallowToSurroundBySpaces) {
             for (const token of this) {
@@ -125,8 +126,8 @@ class TokenCollection extends Array {
             }
         }
         if (this.separator === 'comma') {
-            const tokensWithoutWP = this.filter(token => token.type !== token_1.Token.WhiteSpace);
-            const consecutiveComma = tokensWithoutWP.getConsecutiveToken(token_1.Token.Comma);
+            const tokensWithoutWP = this.filter(token => token.type !== Token.WhiteSpace);
+            const consecutiveComma = tokensWithoutWP.getConsecutiveToken(Token.Comma);
             if (consecutiveComma) {
                 return consecutiveComma.unmatched({
                     reason: 'unexpected-comma',
@@ -134,14 +135,14 @@ class TokenCollection extends Array {
                     expects,
                 });
             }
-            if (tokensWithoutWP[0] && tokensWithoutWP[0].type === token_1.Token.Comma) {
+            if (tokensWithoutWP[0] && tokensWithoutWP[0].type === Token.Comma) {
                 return tokensWithoutWP[0].unmatched({
                     reason: 'unexpected-comma',
                     ref,
                     expects,
                 });
             }
-            const takeTurnsError = tokensWithoutWP.takeTurns([token_1.Token.Ident, token_1.Token.Comma], token_1.Token.Ident);
+            const takeTurnsError = tokensWithoutWP.takeTurns([Token.Ident, Token.Comma], Token.Ident);
             if (takeTurnsError) {
                 if (takeTurnsError.unexpectedLastToken) {
                     return takeTurnsError.token.unmatched({
@@ -167,9 +168,9 @@ class TokenCollection extends Array {
             }
         }
         const identTokens = this.getIdentTokens();
-        const allowEmpty = (_c = this.allowEmpty) !== null && _c !== void 0 ? _c : true;
+        const allowEmpty = this.allowEmpty ?? true;
         if (!allowEmpty && identTokens.length === 0) {
-            return (0, match_result_1.unmatched)(this.value, 'empty-token', {
+            return unmatched(this.value, 'empty-token', {
                 ref,
                 expects,
             });
@@ -185,12 +186,12 @@ class TokenCollection extends Array {
                 });
             }
         }
-        return (0, match_result_1.matched)();
+        return matched();
     }
     chunk(split) {
         const chunks = [];
         const tokens = this.slice();
-        while (tokens.length) {
+        while (tokens.length > 0) {
             const chunkTokens = tokens.splice(0, split);
             const chunk = TokenCollection._new(chunkTokens, this);
             chunks.push(chunk);
@@ -233,10 +234,10 @@ class TokenCollection extends Array {
             wait--;
             const result = callback.call(this, head, tail);
             if (result && !result.matched) {
-                passCount += result.passCount || 0;
+                passCount += result.passCount ?? 0;
                 if (prev && result.offset === 0 && result.length === 0) {
-                    const { offset, line, column } = token_1.Token.shiftLocation(prev, cumulativeOffset);
-                    firstUnmatched = firstUnmatched || {
+                    const { offset, line, column } = Token.shiftLocation(prev, cumulativeOffset);
+                    firstUnmatched = firstUnmatched ?? {
                         ...result,
                         offset,
                         line,
@@ -244,7 +245,7 @@ class TokenCollection extends Array {
                     };
                 }
                 if (!prev && this.value.length === 0) {
-                    firstUnmatched = firstUnmatched || {
+                    firstUnmatched = firstUnmatched ?? {
                         ...result,
                         reason: 'empty-token',
                         expects: undefined,
@@ -261,17 +262,17 @@ class TokenCollection extends Array {
                         }
                     }
                 }
-                firstUnmatched = firstUnmatched || result;
+                firstUnmatched = firstUnmatched ?? result;
             }
             else if (result && !firstUnmatched && result.matched) {
                 return result;
             }
             else {
-                if ((head === null || head === void 0 ? void 0 : head.value) && !head.match(/^\s*$/)) {
+                if (head?.value && !head.match(/^\s*$/)) {
                     passCount += 4 * wait;
                 }
             }
-            cumulativeOffset = (head === null || head === void 0 ? void 0 : head.length) || 0;
+            cumulativeOffset = head?.length ?? 0;
             headAndTail = tail.headAndTail();
             prev = head;
             head = headAndTail.head;
@@ -284,7 +285,7 @@ class TokenCollection extends Array {
             };
             return res;
         }
-        return (0, match_result_1.matched)();
+        return matched();
     }
     filter(callback) {
         return TokenCollection._new(super.filter(callback), this);
@@ -295,7 +296,7 @@ class TokenCollection extends Array {
                 return current;
             }
         });
-        return resultToken || null;
+        return resultToken ?? null;
     }
     getDuplicated() {
         const aList = this.slice();
@@ -319,7 +320,7 @@ class TokenCollection extends Array {
         return null;
     }
     getIdentTokens() {
-        return this.filter(token => token.type === token_1.Token.Ident);
+        return this.filter(token => token.type === Token.Ident);
     }
     /**
      *
@@ -332,7 +333,7 @@ class TokenCollection extends Array {
         const copy = this.slice();
         const head = copy.shift();
         if (!head) {
-            return { head: head || null, tail: TokenCollection._new([], this) };
+            return { head: head ?? null, tail: TokenCollection._new([], this) };
         }
         const tail = TokenCollection._new(copy, this);
         return { head, tail };
@@ -353,6 +354,9 @@ class TokenCollection extends Array {
         const tokens = this.slice();
         for (let i = 0; i < tokens.length; i++) {
             const token = tokens[i];
+            if (!token) {
+                continue;
+            }
             const expectedTokenNumber = tokenNumbers[i % tokenNumbers.length];
             if (token.type !== expectedTokenNumber) {
                 return {
@@ -374,10 +378,11 @@ class TokenCollection extends Array {
     toJSON() {
         return this.map(t => t.toJSON());
     }
-    static _new(tokens, old) {
+    static _new(tokens, 
+    // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+    old) {
         const newCollection = new TokenCollection('', old);
         newCollection.push(...tokens);
         return newCollection;
     }
 }
-exports.TokenCollection = TokenCollection;

package/lib/token/token.d.ts

@@ -1,6 +1,6 @@
-import type { UnmatchedResult, UnmatchedResultOptions, UnmatchedResultReason } from '../types';
+import type { TokenValue } from './types.js';
+import type { UnmatchedResult, UnmatchedResultOptions, UnmatchedResultReason } from '../types.js';
 export declare class Token {
-    #private;
     /**
      * @see https://github.com/csstree/csstree/blob/master/lib/tokenizer/types.js
      */
@@ -20,28 +20,29 @@ export declare class Token {
     static readonly whitespace: ReadonlyArray<string>;
     static getCol(value: string, offset: number): number;
     static getLine(value: string, offset: number): number;
-    static getType(value: string, separators?: string[]): 1 | 13 | 18;
-    static shiftLocation(token: Token, offset: number): {
+    static getType(value: string, separators?: readonly string[]): 1 | 13 | 18;
+    static shiftLocation(token: Readonly<Token>, offset: number): {
         offset: number;
         line: number;
         column: number;
     };
     readonly offset: number;
+    readonly originalValue: string;
     readonly type: number;
     readonly value: string;
-    constructor(value: string, offset: number, originalValue: string, separators?: string[]);
+    constructor(value: string, offset: number, originalValue: string, separators?: readonly string[]);
     get length(): number;
-    get origin(): string;
+    clone(): Token;
     /**
      *
      * @param value The token value or the token type or its list
      */
-    includes(value: string | RegExp | number | (string | RegExp | number)[], caseInsensitive?: boolean): boolean;
+    includes(value: TokenValue, caseInsensitive?: boolean): boolean;
     /**
      *
      * @param value The token value or the token type or its list
      */
-    match(value: string | RegExp | number | (string | RegExp | number)[], caseInsensitive?: boolean): boolean;
+    match(value: TokenValue, caseInsensitive?: boolean): boolean;
     toJSON(): {
         type: number;
         value: string;
@@ -49,7 +50,7 @@ export declare class Token {
     };
     toNumber(): number;
     unmatched(options?: UnmatchedResultOptions & {
-        ref?: string;
-        reason?: UnmatchedResultReason;
+        readonly ref?: string;
+        readonly reason?: UnmatchedResultReason;
     }): UnmatchedResult;
 }

package/lib/token/token.js

@@ -1,21 +1,16 @@
-"use strict";
-var _Token_originalValue;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Token = void 0;
-const tslib_1 = require("tslib");
-class Token {
+export class Token {
     static getCol(value, offset) {
         const lines = value.slice(0, offset).split(/\n/g);
-        return lines[lines.length - 1].length + 1;
+        return (lines[lines.length - 1] ?? '').length + 1;
     }
     static getLine(value, offset) {
         return value.slice(0, offset).split(/\n/g).length;
     }
     static getType(value, separators) {
-        if (Token.whitespace.includes(value[0])) {
+        if (Token.whitespace.includes(value[0] ?? '')) {
             return Token.WhiteSpace;
         }
-        if (separators === null || separators === void 0 ? void 0 : separators.includes(value[0])) {
+        if (separators?.includes(value[0] ?? '')) {
             switch (value[0]) {
                 case ',':
                     return Token.Comma;
@@ -27,22 +22,21 @@ class Token {
         const shifted = token.offset + offset;
         return {
             offset: shifted,
-            line: Token.getLine(tslib_1.__classPrivateFieldGet(token, _Token_originalValue, "f"), shifted),
-            column: Token.getCol(tslib_1.__classPrivateFieldGet(token, _Token_originalValue, "f"), shifted),
+            line: Token.getLine(token.originalValue, shifted),
+            column: Token.getCol(token.originalValue, shifted),
         };
     }
     constructor(value, offset, originalValue, separators) {
-        _Token_originalValue.set(this, void 0);
         this.type = Token.getType(value, separators);
         this.value = value;
         this.offset = offset;
-        tslib_1.__classPrivateFieldSet(this, _Token_originalValue, originalValue, "f");
+        this.originalValue = originalValue;
     }
     get length() {
         return this.value.length;
     }
-    get origin() {
-        return tslib_1.__classPrivateFieldGet(this, _Token_originalValue, "f");
+    clone() {
+        return new Token(this.value, this.offset, this.originalValue);
     }
     /**
      *
@@ -55,7 +49,7 @@ class Token {
         if (typeof value === 'string') {
             const a = caseInsensitive ? this.value.toLowerCase() : this.value;
             const b = caseInsensitive ? value.toLowerCase() : value;
-            return a.indexOf(b) !== -1;
+            return a.includes(b);
         }
         if (value instanceof RegExp) {
             const pattern = new RegExp(value, caseInsensitive ? 'i' : '');
@@ -90,25 +84,23 @@ class Token {
         };
     }
     toNumber() {
-        return parseFloat(this.value);
+        const num = parseFloat(this.value);
+        return isNaN(num) ? 0 : num;
     }
     unmatched(options) {
-        var _a;
         return {
             ...options,
             matched: false,
-            ref: (options === null || options === void 0 ? void 0 : options.ref) || null,
+            ref: options?.ref ?? null,
             raw: this.value,
             offset: this.offset,
             length: this.value.length,
-            line: Token.getLine(tslib_1.__classPrivateFieldGet(this, _Token_originalValue, "f"), this.offset),
-            column: Token.getCol(tslib_1.__classPrivateFieldGet(this, _Token_originalValue, "f"), this.offset),
-            reason: (_a = options === null || options === void 0 ? void 0 : options.reason) !== null && _a !== void 0 ? _a : 'syntax-error',
+            line: Token.getLine(this.originalValue, this.offset),
+            column: Token.getCol(this.originalValue, this.offset),
+            reason: options?.reason ?? 'syntax-error',
         };
     }
 }
-exports.Token = Token;
-_Token_originalValue = new WeakMap();
 /**
  * @see https://github.com/csstree/csstree/blob/master/lib/tokenizer/types.js
  */

package/lib/token/types.d.ts

@@ -0,0 +1,3 @@
+export type TokenValueScalar = string | Readonly<RegExp> | number;
+export type TokenValueArray = readonly TokenValue[];
+export type TokenValue = TokenValueScalar | TokenValueArray;

package/lib/types.d.ts

@@ -1,78 +1,79 @@
-import type { cssSyntaxMatch } from './css-syntax';
-export type { Type, List, Enum, CssSyntax, KeywordDefinedType, Number } from './types.schema';
+import type { cssSyntaxMatch } from './css-syntax.js';
+export type { Type, List, Enum, CssSyntax, KeywordDefinedType, Number } from './types.schema.js';
 export type Result = UnmatchedResult | MatchedResult;
 export type UnmatchedResult = {
-    matched: false;
-    ref: string | null;
-    raw: string;
-    length: number;
-    offset: number;
-    line: number;
-    column: number;
-    reason: UnmatchedResultReason;
-    passCount?: number;
+    readonly matched: false;
+    readonly ref: string | null;
+    readonly raw: string;
+    readonly length: number;
+    readonly offset: number;
+    readonly line: number;
+    readonly column: number;
+    readonly reason: UnmatchedResultReason;
+    readonly passCount?: number;
 } & UnmatchedResultOptions;
 export type UnmatchedResultOptions = {
-    partName?: string;
-    expects?: Expect[];
-    extra?: Expect;
-    candidate?: string;
+    readonly partName?: string;
+    readonly expects?: readonly Expect[];
+    readonly extra?: Expect;
+    readonly candidate?: string;
+    readonly fallbackTo?: string;
 };
 export type UnmatchedResultReason = 'syntax-error' | 'typo' | 'missing-token' | 'missing-comma' | 'unexpected-token' | 'unexpected-space' | 'unexpected-newline' | 'unexpected-comma' | 'empty-token' | 'out-of-range' | 'doesnt-exist-in-enum' | 'duplicated' | 'illegal-combination' | 'illegal-order' | 'extra-token' | 'must-be-percent-encoded' | 'must-be-serialized' | {
-    type: 'out-of-range';
-    gt?: number;
-    gte?: number;
-    lt?: number;
-    lte?: number;
+    readonly type: 'out-of-range';
+    readonly gt?: number;
+    readonly gte?: number;
+    readonly lt?: number;
+    readonly lte?: number;
 } | {
-    type: 'out-of-range-length-char';
-    gte: number;
-    lte?: number;
+    readonly type: 'out-of-range-length-char';
+    readonly gte: number;
+    readonly lte?: number;
 } | {
-    type: 'out-of-range-length-digit';
-    gte: number;
-    lte?: number;
+    readonly type: 'out-of-range-length-digit';
+    readonly gte: number;
+    readonly lte?: number;
 };
 export type MatchedResult = {
-    matched: true;
+    readonly matched: true;
 };
 export type Expect = {
-    type: 'const' | 'format' | 'syntax' | 'regexp' | 'common';
-    value: string;
+    readonly type: 'const' | 'format' | 'syntax' | 'regexp' | 'common';
+    readonly value: string;
 };
 export type FormattedPrimitiveTypeCheck = (value: string) => boolean;
 export type FormattedPrimitiveTypeCreator<O = never> = (options?: O) => FormattedPrimitiveTypeCheck;
 export type Defs = Record<string, CustomCssSyntax | CustomSyntax>;
 export type CustomSyntax = {
-    ref: string;
-    expects?: Expect[];
-    is: CustomSyntaxCheck;
+    readonly ref: string;
+    readonly expects?: readonly Expect[];
+    readonly is: CustomSyntaxCheck;
 };
 export type CustomSyntaxCheck = (value: string) => Result;
 export type CustomSyntaxChecker<O = {}> = (options?: O) => CustomSyntaxCheck;
 export type CustomCssSyntax = {
-    ref: string;
-    caseSensitive?: boolean;
-    expects?: Expect[];
-    syntax: {
-        apply: `<${string}>`;
-        def: Record<string, string | CssSyntaxTokenizer>;
+    readonly ref: string;
+    readonly caseSensitive?: boolean;
+    readonly expects?: readonly Expect[];
+    readonly syntax: {
+        readonly apply: `<${string}>`;
+        readonly def: Readonly<Record<string, string | CssSyntaxTokenizer>>;
         /**
          * @deprecated
          */
-        ebnf?: Record<string, string | string[]>;
+        readonly ebnf?: Readonly<Record<string, string | readonly string[]>>;
         /**
          * @deprecated
          */
-        properties?: Record<string, string>;
+        readonly properties?: Readonly<Record<string, string>>;
     };
 };
 export type CSSSyntaxToken = {
-    type: number;
-    value: string;
-    index: number;
-    balance: number;
-    node?: any;
+    readonly type: number;
+    readonly value: string;
+    readonly index: number;
+    readonly balance: number;
+    readonly node?: any;
 };
-export type CssSyntaxTokenizer = (token: CSSSyntaxToken | null, getNextToken: GetNextToken, match: typeof cssSyntaxMatch) => number;
+export type CssSyntaxTokenizer = (token: Readonly<CSSSyntaxToken> | null, getNextToken: GetNextToken, match: typeof cssSyntaxMatch) => number;
 export type GetNextToken = (length: number) => CSSSyntaxToken | null;

package/lib/types.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};