@markuplint/types 3.4.0 → 3.5.1

package/lib/check-multi-types.d.ts

@@ -1,2 +1,2 @@
 import type { CustomSyntaxCheck, UnmatchedResult } from './types';
-export declare function checkMultiTypes(value: string, checks: readonly CustomSyntaxCheck[]): import("./types").MatchedResult | UnmatchedResult;
+export declare function checkMultiTypes(value: string, checks: readonly CustomSyntaxCheck[]): UnmatchedResult | import("./types").MatchedResult;

package/lib/check-multi-types.js

@@ -4,6 +4,7 @@ exports.checkMultiTypes = void 0;
 const debug_1 = require("./debug");
 const match_result_1 = require("./match-result");
 function checkMultiTypes(value, checks) {
+    var _a, _b, _c;
     let unmatched;
     for (const check of checks) {
         const res = check(value);
@@ -14,15 +15,15 @@ function checkMultiTypes(value, checks) {
         res._fn = check.name;
         // @ts-ignore
         (0, debug_1.log)('%s(%d) vs %s(%d)', unmatched === null || unmatched === void 0 ? void 0 : unmatched._fn, unmatched === null || unmatched === void 0 ? void 0 : unmatched.passCount, res._fn, res.passCount);
-        const passedA = (unmatched === null || unmatched === void 0 ? void 0 : unmatched.passCount) || 0;
-        const passedB = res.passCount || 0;
-        const offsetA = (unmatched === null || unmatched === void 0 ? void 0 : unmatched.offset) || 0;
+        const passedA = (_a = unmatched === null || unmatched === void 0 ? void 0 : unmatched.passCount) !== null && _a !== void 0 ? _a : 0;
+        const passedB = (_b = res.passCount) !== null && _b !== void 0 ? _b : 0;
+        const offsetA = (_c = unmatched === null || unmatched === void 0 ? void 0 : unmatched.offset) !== null && _c !== void 0 ? _c : 0;
         const offsetB = res.offset;
         if (passedA < passedB || (passedA === passedB && offsetA <= offsetB)) {
             unmatched = res;
         }
     }
-    const result = unmatched || (0, match_result_1.matched)();
+    const result = unmatched !== null && unmatched !== void 0 ? unmatched : (0, match_result_1.matched)();
     (0, debug_1.log)('%d checks result: %O', checks.length, result);
     return result;
 }

package/lib/check.spec.js

@@ -75,3 +75,8 @@ test('Non-exist types', () => {
     // @ts-ignore
     expect((0, check_1.check)('abc', '').matched).toBe(true);
 });
+test('ItemProp', () => {
+    expect((0, check_1.check)('itemListElement', 'ItemProp').matched).toBe(true);
+    expect((0, check_1.check)('item', 'ItemProp').matched).toBe(true);
+    expect((0, check_1.check)('position', 'ItemProp').matched).toBe(true);
+});

package/lib/css-syntax.js

@@ -9,6 +9,7 @@ const MIMIC_TAG_L = 'mimiccases---';
 const MIMIC_TAG_R = '---mimiccases';
 const MIMIC_LENGTH = (MIMIC_TAG_L + MIMIC_TAG_R).length;
 function cssSyntaxMatch(value, type) {
+    var _a;
     (0, debug_1.log)('Search CSS Syntax: "%s"', type);
     const origin = value;
     let defName;
@@ -24,7 +25,7 @@ function cssSyntaxMatch(value, type) {
     }
     else {
         defName = type.syntax.apply;
-        ebnf = type.syntax.ebnf || null;
+        ebnf = (_a = type.syntax.ebnf) !== null && _a !== void 0 ? _a : null;
         if (ebnf) {
             // Work in progress
             return (0, match_result_1.matched)();
@@ -69,7 +70,7 @@ function cssSyntaxMatch(value, type) {
         throw new Error('MARKUPLINT_TYPE_NO_EXIST');
     }
     const refParam = isProp ? 'Property' : 'Type';
-    ref = ref || `https://csstree.github.io/docs/syntax/#${refParam}:${name}`;
+    ref = ref !== null && ref !== void 0 ? ref : `https://csstree.github.io/docs/syntax/#${refParam}:${name}`;
     // eslint-disable-next-line no-console
     const _w = console.warn;
     if (debug_1.log.enabled) {

package/lib/defs.js

@@ -115,7 +115,7 @@ exports.types = {
                     reason: 'unexpected-space',
                 });
             }
-            if (!tokens.length) {
+            if (tokens.length === 0) {
                 return (0, match_result_1.unmatched)(value, 'empty-token');
             }
             return (0, match_result_1.matched)();
@@ -431,7 +431,7 @@ exports.types = {
             if (!height) {
                 return sep.unmatched({ reason: 'unexpected-token' });
             }
-            if (tail && tail[0]) {
+            if (tail[0]) {
                 return tail[0].unmatched({ reason: 'extra-token' });
             }
             if (!(0, primitive_1.isUint)(width.value)) {

package/lib/get-candidate.d.ts

@@ -1,3 +1,6 @@
 type NullableString = string | null | undefined;
-export declare function getCandidate(value: NullableString, ...candidates: readonly (NullableString | readonly NullableString[])[]): string | undefined;
+export declare function getCandidate(
+	value: NullableString,
+	...candidates: readonly (NullableString | readonly NullableString[])[]
+): string | undefined;
 export {};

package/lib/keyword-type.js

@@ -33,6 +33,7 @@ function checkKeywordType(value, type, cache = true) {
 }
 exports.checkKeywordType = checkKeywordType;
 function _checkKeywordType(value, type) {
+    var _a, _b;
     const def = defs_1.types[type];
     if (!def) {
         (0, debug_1.log)('The "%s" type is not defined in custom type identifier markuplint specified', type);
@@ -51,8 +52,8 @@ function _checkKeywordType(value, type) {
     if (!matches.matched) {
         return {
             ...matches,
-            ref: matches.ref || def.ref,
-            expects: matches.expects || def.expects,
+            ref: (_a = matches.ref) !== null && _a !== void 0 ? _a : def.ref,
+            expects: (_b = matches.expects) !== null && _b !== void 0 ? _b : def.expects,
         };
     }
     return matches;

package/lib/list.js

@@ -5,6 +5,7 @@ const check_1 = require("./check");
 const match_result_1 = require("./match-result");
 const token_1 = require("./token");
 function checkList(value, type, ref, cache = true) {
+    var _a;
     const tokens = new token_1.TokenCollection(value, type);
     const matches = tokens.check({ ref });
     if (!matches.matched) {
@@ -17,7 +18,7 @@ function checkList(value, type, ref, cache = true) {
             const { offset, line, column } = token_1.Token.shiftLocation(token, res.offset);
             return {
                 ...res,
-                partName: res.partName || 'the content of the list',
+                partName: (_a = res.partName) !== null && _a !== void 0 ? _a : 'the content of the list',
                 offset,
                 line,
                 column,

package/lib/match-result.d.ts

@@ -2,7 +2,7 @@ import type { FormattedPrimitiveTypeCheck, MatchedResult, UnmatchedResult, Unmat
 export declare function matches(checker: FormattedPrimitiveTypeCheck, options?: UnmatchedResultOptions & {
     readonly ref?: string;
     readonly reason?: UnmatchedResultReason;
-}): (value: string) => MatchedResult | UnmatchedResult;
+}): (value: string) => UnmatchedResult | MatchedResult;
 export declare function matched(): MatchedResult;
 export declare function unmatched(value: string, reason?: UnmatchedResultReason, options?: UnmatchedResultOptions & {
     readonly ref?: string;

package/lib/match-result.js

@@ -18,10 +18,11 @@ function matched() {
 }
 exports.matched = matched;
 function unmatched(value, reason, options) {
+    var _a;
     return {
         ...options,
         matched: false,
-        ref: (options === null || options === void 0 ? void 0 : options.ref) || null,
+        ref: (_a = options === null || options === void 0 ? void 0 : options.ref) !== null && _a !== void 0 ? _a : null,
         raw: value,
         offset: 0,
         length: value.length,

package/lib/primitive/is-quantity.d.ts

@@ -4,4 +4,8 @@
  * @param units
  * @param numberType
  */
-export declare function isQuantity(value: string, units: readonly string[], numberType?: 'int' | 'uint' | 'float'): boolean;
+export declare function isQuantity(
+	value: string,
+	units: readonly string[],
+	numberType?: 'int' | 'uint' | 'float',
+): boolean;

package/lib/primitive/is-uint.d.ts

@@ -3,6 +3,9 @@
  *
  * @param value
  */
-export declare function isUint(value: string, options?: {
-    readonly gt?: number;
-}): boolean;
+export declare function isUint(
+	value: string,
+	options?: {
+		readonly gt?: number;
+	},
+): boolean;

package/lib/primitive/split-unit.d.ts

@@ -4,6 +4,6 @@
  * @returns
  */
 export declare function splitUnit(value: string): {
-    num: string;
-    unit: string;
+	num: string;
+	unit: string;
 };

package/lib/token/token-collection.d.ts

@@ -26,7 +26,7 @@ export declare class TokenCollection extends Array<Token> {
         expects?: Expect[];
         ref?: string;
         cache?: boolean;
-    }): import("..").MatchedResult | UnmatchedResult;
+    }): UnmatchedResult | import("..").MatchedResult;
     chunk(split: number): TokenCollection[];
     compareTokens(callback: (prev: Readonly<Token>, current: Readonly<Token>) => Readonly<Token> | null | void): Readonly<Token> | null | undefined;
     divide(position: number): readonly [TokenCollection, TokenCollection];

package/lib/token/token-collection.js

@@ -5,6 +5,7 @@ const match_result_1 = require("../match-result");
 const token_1 = require("./token");
 class TokenCollection extends Array {
     static fromPatterns(value, patterns, typeOptions) {
+        var _c;
         const originalValue = typeof value === 'string' ? value : value.originalValue;
         let strings = typeof value === 'string' ? value : value.value;
         let cumulativeOffset = typeof value === 'string' ? 0 : value.offset;
@@ -31,7 +32,7 @@ class TokenCollection extends Array {
                         value = strings.slice(res.index + res[0].length);
                     }
                     else {
-                        value = res[0] || '';
+                        value = (_c = res[0]) !== null && _c !== void 0 ? _c : '';
                     }
                 }
                 const token = addToken(value);
@@ -51,14 +52,15 @@ class TokenCollection extends Array {
         return Array;
     }
     constructor(value, typeOptions) {
+        var _c, _d, _e, _f, _g, _h;
         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.disallowToSurroundBySpaces = (_c = typeOptions === null || typeOptions === void 0 ? void 0 : typeOptions.disallowToSurroundBySpaces) !== null && _c !== void 0 ? _c : false;
+        this.allowEmpty = (_d = typeOptions === null || typeOptions === void 0 ? void 0 : typeOptions.allowEmpty) !== null && _d !== void 0 ? _d : true;
+        this.ordered = (_e = typeOptions === null || typeOptions === void 0 ? void 0 : typeOptions.ordered) !== null && _e !== void 0 ? _e : false;
+        this.unique = (_f = typeOptions === null || typeOptions === void 0 ? void 0 : typeOptions.unique) !== null && _f !== void 0 ? _f : false;
+        this.caseInsensitive = (_g = typeOptions === null || typeOptions === void 0 ? void 0 : typeOptions.caseInsensitive) !== null && _g !== void 0 ? _g : 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.separator = (_h = typeOptions === null || typeOptions === void 0 ? void 0 : typeOptions.separator) !== null && _h !== void 0 ? _h : 'space';
         if (typeof value === 'number') {
             this.length = value;
             return;
@@ -70,7 +72,7 @@ class TokenCollection extends Array {
         if (this.separator === 'comma') {
             separators.push(',');
         }
-        if (typeOptions === null || typeOptions === void 0 ? void 0 : typeOptions.specificSeparator) {
+        if ((typeOptions === null || typeOptions === void 0 ? void 0 : typeOptions.specificSeparator) != null) {
             if (typeof typeOptions.specificSeparator === 'string') {
                 separators.push(typeOptions.specificSeparator);
             }
@@ -191,7 +193,7 @@ class TokenCollection extends Array {
     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);
@@ -222,6 +224,7 @@ class TokenCollection extends Array {
         return [a, b];
     }
     eachCheck(...callbacks) {
+        var _c, _d;
         let headAndTail = this.headAndTail();
         let head = headAndTail.head;
         let tail = headAndTail.tail;
@@ -234,10 +237,10 @@ class TokenCollection extends Array {
             wait--;
             const result = callback.call(this, head, tail);
             if (result && !result.matched) {
-                passCount += result.passCount || 0;
+                passCount += (_c = result.passCount) !== null && _c !== void 0 ? _c : 0;
                 if (prev && result.offset === 0 && result.length === 0) {
                     const { offset, line, column } = token_1.Token.shiftLocation(prev, cumulativeOffset);
-                    firstUnmatched = firstUnmatched || {
+                    firstUnmatched = firstUnmatched !== null && firstUnmatched !== void 0 ? firstUnmatched : {
                         ...result,
                         offset,
                         line,
@@ -245,7 +248,7 @@ class TokenCollection extends Array {
                     };
                 }
                 if (!prev && this.value.length === 0) {
-                    firstUnmatched = firstUnmatched || {
+                    firstUnmatched = firstUnmatched !== null && firstUnmatched !== void 0 ? firstUnmatched : {
                         ...result,
                         reason: 'empty-token',
                         expects: undefined,
@@ -262,7 +265,7 @@ class TokenCollection extends Array {
                         }
                     }
                 }
-                firstUnmatched = firstUnmatched || result;
+                firstUnmatched = firstUnmatched !== null && firstUnmatched !== void 0 ? firstUnmatched : result;
             }
             else if (result && !firstUnmatched && result.matched) {
                 return result;
@@ -272,7 +275,7 @@ class TokenCollection extends Array {
                     passCount += 4 * wait;
                 }
             }
-            cumulativeOffset = (head === null || head === void 0 ? void 0 : head.length) || 0;
+            cumulativeOffset = (_d = head === null || head === void 0 ? void 0 : head.length) !== null && _d !== void 0 ? _d : 0;
             headAndTail = tail.headAndTail();
             prev = head;
             head = headAndTail.head;
@@ -296,7 +299,7 @@ class TokenCollection extends Array {
                 return current;
             }
         });
-        return resultToken || null;
+        return resultToken !== null && resultToken !== void 0 ? resultToken : null;
     }
     getDuplicated() {
         const aList = this.slice();
@@ -333,7 +336,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 && head !== void 0 ? head : null, tail: TokenCollection._new([], this) };
         }
         const tail = TokenCollection._new(copy, this);
         return { head, tail };

package/lib/token/token.d.ts

@@ -20,7 +20,7 @@ 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?: readonly string[]): 1 | 13 | 18;
+    static getType(value: string, separators?: readonly string[]): 18 | 1 | 13;
     static shiftLocation(token: Readonly<Token>, offset: number): {
         offset: number;
         line: number;

package/lib/token/token.js

@@ -54,7 +54,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' : '');
@@ -89,20 +89,21 @@ class Token {
         };
     }
     toNumber() {
-        return parseFloat(this.value);
+        const num = parseFloat(this.value);
+        return isNaN(num) ? 0 : num;
     }
     unmatched(options) {
-        var _a;
+        var _a, _b;
         return {
             ...options,
             matched: false,
-            ref: (options === null || options === void 0 ? void 0 : options.ref) || null,
+            ref: (_a = options === null || options === void 0 ? void 0 : options.ref) !== null && _a !== void 0 ? _a : null,
             raw: this.value,
             offset: this.offset,
             length: this.value.length,
             line: Token.getLine(this.originalValue, this.offset),
             column: Token.getCol(this.originalValue, this.offset),
-            reason: (_a = options === null || options === void 0 ? void 0 : options.reason) !== null && _a !== void 0 ? _a : 'syntax-error',
+            reason: (_b = options === null || options === void 0 ? void 0 : options.reason) !== null && _b !== void 0 ? _b : 'syntax-error',
         };
     }
 }

package/lib/types.d.ts

@@ -2,77 +2,101 @@ import type { cssSyntaxMatch } from './css-syntax';
 export type { Type, List, Enum, CssSyntax, KeywordDefinedType, Number } from './types.schema';
 export type Result = UnmatchedResult | MatchedResult;
 export type UnmatchedResult = {
-    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;
+	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 = {
-    readonly partName?: string;
-    readonly expects?: readonly Expect[];
-    readonly extra?: Expect;
-    readonly candidate?: 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' | {
-    readonly type: 'out-of-range';
-    readonly gt?: number;
-    readonly gte?: number;
-    readonly lt?: number;
-    readonly lte?: number;
-} | {
-    readonly type: 'out-of-range-length-char';
-    readonly gte: number;
-    readonly lte?: number;
-} | {
-    readonly type: 'out-of-range-length-digit';
-    readonly gte: number;
-    readonly lte?: number;
+	readonly partName?: string;
+	readonly expects?: readonly Expect[];
+	readonly extra?: Expect;
+	readonly candidate?: 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'
+	| {
+			readonly type: 'out-of-range';
+			readonly gt?: number;
+			readonly gte?: number;
+			readonly lt?: number;
+			readonly lte?: number;
+	  }
+	| {
+			readonly type: 'out-of-range-length-char';
+			readonly gte: number;
+			readonly lte?: number;
+	  }
+	| {
+			readonly type: 'out-of-range-length-digit';
+			readonly gte: number;
+			readonly lte?: number;
+	  };
 export type MatchedResult = {
-    readonly matched: true;
+	readonly matched: true;
 };
 export type Expect = {
-    readonly type: 'const' | 'format' | 'syntax' | 'regexp' | 'common';
-    readonly 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 = {
-    readonly ref: string;
-    readonly expects?: readonly Expect[];
-    readonly 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 = {
-    readonly ref: string;
-    readonly caseSensitive?: boolean;
-    readonly expects?: readonly Expect[];
-    readonly syntax: {
-        readonly apply: `<${string}>`;
-        readonly def: Readonly<Record<string, string | CssSyntaxTokenizer>>;
-        /**
-         * @deprecated
-         */
-        readonly ebnf?: Readonly<Record<string, string | readonly string[]>>;
-        /**
-         * @deprecated
-         */
-        readonly properties?: Readonly<Record<string, string>>;
-    };
+	readonly ref: string;
+	readonly caseSensitive?: boolean;
+	readonly expects?: readonly Expect[];
+	readonly syntax: {
+		readonly apply: `<${string}>`;
+		readonly def: Readonly<Record<string, string | CssSyntaxTokenizer>>;
+		/**
+		 * @deprecated
+		 */
+		readonly ebnf?: Readonly<Record<string, string | readonly string[]>>;
+		/**
+		 * @deprecated
+		 */
+		readonly properties?: Readonly<Record<string, string>>;
+	};
 };
 export type CSSSyntaxToken = {
-    readonly type: number;
-    readonly value: string;
-    readonly index: number;
-    readonly balance: number;
-    readonly node?: any;
+	readonly type: number;
+	readonly value: string;
+	readonly index: number;
+	readonly balance: number;
+	readonly node?: any;
 };
-export type CssSyntaxTokenizer = (token: Readonly<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;