@markuplint/types 3.0.0-canary.5 → 3.0.0-dev.176

package/lib/css-syntax.spec.js

@@ -1,157 +1,160 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const css_syntax_1 = require("./css-syntax");
+'use strict';
+// @ts-nocheck
+Object.defineProperty(exports, '__esModule', { value: true });
+const css_syntax_1 = require('./css-syntax');
 test('CSS Standard', () => {
-    expect((0, css_syntax_1.cssSyntaxMatch)('10px', '<length>').matched).toBe(true);
-    expect((0, css_syntax_1.cssSyntaxMatch)('one-pixel', '<length>').matched).toBe(false);
-    expect((0, css_syntax_1.cssSyntaxMatch)('(prefers-color-scheme: dark)', '<media-query-list>').matched).toBe(true);
+	expect((0, css_syntax_1.cssSyntaxMatch)('10px', '<length>').matched).toBe(true);
+	expect((0, css_syntax_1.cssSyntaxMatch)('one-pixel', '<length>').matched).toBe(false);
+	expect((0, css_syntax_1.cssSyntaxMatch)('(prefers-color-scheme: dark)', '<media-query-list>').matched).toBe(true);
 });
 test('Extends', () => {
-    const sourceSizeList = {
-        ref: 'https://html.spec.whatwg.org/multipage/images.html#sizes-attributes',
-        syntax: {
-            apply: '<source-size-list>',
-            def: {
-                'source-size-list': '[ <source-size># , ]? <source-size-value>',
-                'source-size': '<media-condition> <source-size-value>',
-                'source-size-value': '<length>',
-            },
-        },
-    };
-    expect((0, css_syntax_1.cssSyntaxMatch)('50vw', sourceSizeList).matched).toBe(true);
-    expect((0, css_syntax_1.cssSyntaxMatch)('(max-width: 600px) 200px, 50vw', sourceSizeList).matched).toBe(true);
-    expect((0, css_syntax_1.cssSyntaxMatch)('print 300vw', sourceSizeList).matched).toBe(false);
-    expect((0, css_syntax_1.cssSyntaxMatch)('(max-width: 600px) 200px', sourceSizeList).matched).toBe(false);
-    expect((0, css_syntax_1.cssSyntaxMatch)('(max-width: 600px) 200px', {
-        ...sourceSizeList,
-        syntax: {
-            ...sourceSizeList.syntax,
-            apply: '<source-size>',
-        },
-    }).matched).toBe(true);
-    const keyTimes = {
-        ref: 'https://svgwg.org/specs/animations/#KeyTimesAttribute',
-        syntax: {
-            apply: '<key-times>',
-            def: {
-                'key-times': '<number> [; <number>]* [;]?',
-            },
-        },
-    };
-    expect((0, css_syntax_1.cssSyntaxMatch)('20; 20; 30', keyTimes).matched).toBe(true);
-    expect((0, css_syntax_1.cssSyntaxMatch)('20; 20; 30;', keyTimes).matched).toBe(true);
-    expect((0, css_syntax_1.cssSyntaxMatch)('20; 20; abc;', keyTimes).matched).toBe(false);
-    expect((0, css_syntax_1.cssSyntaxMatch)('20; 20; ;', keyTimes).matched).toBe(false);
-    const SVGViewBox = {
-        ref: 'https://svgwg.org/svg2-draft/coords.html#ViewBoxAttribute',
-        syntax: {
-            apply: '<view-box>',
-            def: {
-                'view-box': '<min-x> [,]? <min-y> [,]? <width> [,]? <height>',
-                'min-x': '<number>',
-                'min-y': '<number>',
-                width: '<number>',
-                height: '<number>',
-            },
-        },
-    };
-    expect((0, css_syntax_1.cssSyntaxMatch)('0 0 30 10', SVGViewBox).matched).toBe(true);
-    expect((0, css_syntax_1.cssSyntaxMatch)('0 0, 30, 10', SVGViewBox).matched).toBe(true);
-    expect((0, css_syntax_1.cssSyntaxMatch)('0 0, 30', SVGViewBox).matched).toBe(false);
-    const percentageList = {
-        ref: 'https://developer.mozilla.org/en-US/docs/Web/SVG/Content_type#percentage',
-        syntax: {
-            apply: '<percentage-list>',
-            def: {
-                'percentage-list': '[ <number> [,]? ]* <number>',
-            },
-        },
-    };
-    expect((0, css_syntax_1.cssSyntaxMatch)('0 0 30 10', percentageList).matched).toBe(true);
-    expect((0, css_syntax_1.cssSyntaxMatch)('0, 0, 30 10', percentageList).matched).toBe(true);
-    expect((0, css_syntax_1.cssSyntaxMatch)('0', percentageList).matched).toBe(true);
-    expect((0, css_syntax_1.cssSyntaxMatch)('', percentageList).matched).toBe(false);
-    const custom = {
-        ref: 'n/a',
-        syntax: {
-            apply: '<custom>',
-            def: {
-                custom: '0 | 1 | .',
-            },
-        },
-    };
-    expect((0, css_syntax_1.cssSyntaxMatch)('0', custom).matched).toBe(true);
-    expect((0, css_syntax_1.cssSyntaxMatch)('1', custom).matched).toBe(true);
-    expect((0, css_syntax_1.cssSyntaxMatch)('.', custom).matched).toBe(true);
-    expect((0, css_syntax_1.cssSyntaxMatch)('2', custom).matched).toBe(false);
-    expect((0, css_syntax_1.cssSyntaxMatch)(':', custom).matched).toBe(false);
+	const sourceSizeList = {
+		ref: 'https://html.spec.whatwg.org/multipage/images.html#sizes-attributes',
+		syntax: {
+			apply: '<source-size-list>',
+			def: {
+				'source-size-list': '[ <source-size># , ]? <source-size-value>',
+				'source-size': '<media-condition> <source-size-value>',
+				'source-size-value': '<length>',
+			},
+		},
+	};
+	expect((0, css_syntax_1.cssSyntaxMatch)('50vw', sourceSizeList).matched).toBe(true);
+	expect((0, css_syntax_1.cssSyntaxMatch)('(max-width: 600px) 200px, 50vw', sourceSizeList).matched).toBe(true);
+	expect((0, css_syntax_1.cssSyntaxMatch)('print 300vw', sourceSizeList).matched).toBe(false);
+	expect((0, css_syntax_1.cssSyntaxMatch)('(max-width: 600px) 200px', sourceSizeList).matched).toBe(false);
+	expect(
+		(0, css_syntax_1.cssSyntaxMatch)('(max-width: 600px) 200px', {
+			...sourceSizeList,
+			syntax: {
+				...sourceSizeList.syntax,
+				apply: '<source-size>',
+			},
+		}).matched,
+	).toBe(true);
+	const keyTimes = {
+		ref: 'https://svgwg.org/specs/animations/#KeyTimesAttribute',
+		syntax: {
+			apply: '<key-times>',
+			def: {
+				'key-times': '<number> [; <number>]* [;]?',
+			},
+		},
+	};
+	expect((0, css_syntax_1.cssSyntaxMatch)('20; 20; 30', keyTimes).matched).toBe(true);
+	expect((0, css_syntax_1.cssSyntaxMatch)('20; 20; 30;', keyTimes).matched).toBe(true);
+	expect((0, css_syntax_1.cssSyntaxMatch)('20; 20; abc;', keyTimes).matched).toBe(false);
+	expect((0, css_syntax_1.cssSyntaxMatch)('20; 20; ;', keyTimes).matched).toBe(false);
+	const SVGViewBox = {
+		ref: 'https://svgwg.org/svg2-draft/coords.html#ViewBoxAttribute',
+		syntax: {
+			apply: '<view-box>',
+			def: {
+				'view-box': '<min-x> [,]? <min-y> [,]? <width> [,]? <height>',
+				'min-x': '<number>',
+				'min-y': '<number>',
+				width: '<number>',
+				height: '<number>',
+			},
+		},
+	};
+	expect((0, css_syntax_1.cssSyntaxMatch)('0 0 30 10', SVGViewBox).matched).toBe(true);
+	expect((0, css_syntax_1.cssSyntaxMatch)('0 0, 30, 10', SVGViewBox).matched).toBe(true);
+	expect((0, css_syntax_1.cssSyntaxMatch)('0 0, 30', SVGViewBox).matched).toBe(false);
+	const percentageList = {
+		ref: 'https://developer.mozilla.org/en-US/docs/Web/SVG/Content_type#percentage',
+		syntax: {
+			apply: '<percentage-list>',
+			def: {
+				'percentage-list': '[ <number> [,]? ]* <number>',
+			},
+		},
+	};
+	expect((0, css_syntax_1.cssSyntaxMatch)('0 0 30 10', percentageList).matched).toBe(true);
+	expect((0, css_syntax_1.cssSyntaxMatch)('0, 0, 30 10', percentageList).matched).toBe(true);
+	expect((0, css_syntax_1.cssSyntaxMatch)('0', percentageList).matched).toBe(true);
+	expect((0, css_syntax_1.cssSyntaxMatch)('', percentageList).matched).toBe(false);
+	const custom = {
+		ref: 'n/a',
+		syntax: {
+			apply: '<custom>',
+			def: {
+				custom: '0 | 1 | .',
+			},
+		},
+	};
+	expect((0, css_syntax_1.cssSyntaxMatch)('0', custom).matched).toBe(true);
+	expect((0, css_syntax_1.cssSyntaxMatch)('1', custom).matched).toBe(true);
+	expect((0, css_syntax_1.cssSyntaxMatch)('.', custom).matched).toBe(true);
+	expect((0, css_syntax_1.cssSyntaxMatch)('2', custom).matched).toBe(false);
+	expect((0, css_syntax_1.cssSyntaxMatch)(':', custom).matched).toBe(false);
 });
 test('custom-type-checking', () => {
-    const custom = {
-        ref: 'n/a',
-        caseSensitive: true,
-        syntax: {
-            apply: '<custom>',
-            def: {
-                custom: '<custom-type>',
-                'custom-type': token => {
-                    if (!token) {
-                        return 0;
-                    }
-                    return token.value === '1' ? 1 : 0;
-                },
-            },
-        },
-    };
-    expect((0, css_syntax_1.cssSyntaxMatch)('1', custom).matched).toBe(true);
-    expect((0, css_syntax_1.cssSyntaxMatch)('0', custom).matched).toBe(false);
+	const custom = {
+		ref: 'n/a',
+		caseSensitive: true,
+		syntax: {
+			apply: '<custom>',
+			def: {
+				custom: '<custom-type>',
+				'custom-type': token => {
+					if (!token) {
+						return 0;
+					}
+					return token.value === '1' ? 1 : 0;
+				},
+			},
+		},
+	};
+	expect((0, css_syntax_1.cssSyntaxMatch)('1', custom).matched).toBe(true);
+	expect((0, css_syntax_1.cssSyntaxMatch)('0', custom).matched).toBe(false);
 });
 test('case-sensitive', () => {
-    const custom = {
-        ref: 'n/a',
-        caseSensitive: true,
-        syntax: {
-            apply: '<custom>',
-            def: {
-                custom: 'CaSeS [a | B | aBc]',
-            },
-        },
-    };
-    expect((0, css_syntax_1.cssSyntaxMatch)('CaSeS a', custom).matched).toBe(true);
-    expect((0, css_syntax_1.cssSyntaxMatch)('CaSeS B', custom).matched).toBe(true);
-    expect((0, css_syntax_1.cssSyntaxMatch)('CaSeS aBc', custom).matched).toBe(true);
-    expect((0, css_syntax_1.cssSyntaxMatch)('CaSeS A', custom)).toStrictEqual({
-        column: 7,
-        line: 1,
-        matched: false,
-        length: 1,
-        offset: 6,
-        partName: 'value',
-        raw: 'A',
-        reason: 'syntax-error',
-        ref: 'n/a',
-        expects: [
-            {
-                type: 'syntax',
-                value: 'CaSeS [ a | B | aBc ]',
-            },
-        ],
-    });
-    expect((0, css_syntax_1.cssSyntaxMatch)('CaSeS abc', custom)).toStrictEqual({
-        column: 7,
-        line: 1,
-        matched: false,
-        length: 3,
-        offset: 6,
-        partName: 'value',
-        raw: 'abc',
-        reason: 'syntax-error',
-        ref: 'n/a',
-        expects: [
-            {
-                type: 'syntax',
-                value: 'CaSeS [ a | B | aBc ]',
-            },
-        ],
-    });
+	const custom = {
+		ref: 'n/a',
+		caseSensitive: true,
+		syntax: {
+			apply: '<custom>',
+			def: {
+				custom: 'CaSeS [a | B | aBc]',
+			},
+		},
+	};
+	expect((0, css_syntax_1.cssSyntaxMatch)('CaSeS a', custom).matched).toBe(true);
+	expect((0, css_syntax_1.cssSyntaxMatch)('CaSeS B', custom).matched).toBe(true);
+	expect((0, css_syntax_1.cssSyntaxMatch)('CaSeS aBc', custom).matched).toBe(true);
+	expect((0, css_syntax_1.cssSyntaxMatch)('CaSeS A', custom)).toStrictEqual({
+		column: 7,
+		line: 1,
+		matched: false,
+		length: 1,
+		offset: 6,
+		partName: 'value',
+		raw: 'A',
+		reason: 'syntax-error',
+		ref: 'n/a',
+		expects: [
+			{
+				type: 'syntax',
+				value: '<custom>',
+			},
+		],
+	});
+	expect((0, css_syntax_1.cssSyntaxMatch)('CaSeS abc', custom)).toStrictEqual({
+		column: 7,
+		line: 1,
+		matched: false,
+		length: 3,
+		offset: 6,
+		partName: 'value',
+		raw: 'abc',
+		reason: 'syntax-error',
+		ref: 'n/a',
+		expects: [
+			{
+				type: 'syntax',
+				value: '<custom>',
+			},
+		],
+	});
 });

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.length) {
+            if (tail[0]) {
                 return tail[0].unmatched({ reason: 'extra-token' });
             }
             if (!(0, primitive_1.isUint)(width.value)) {

package/lib/enum.d.ts

@@ -1,3 +1,4 @@
 import type { Result } from './types';
 import type { Enum } from './types.schema';
-export declare function checkEnum(value: string, type: Enum, ref?: string): Result;
+import type { ReadonlyDeep } from 'type-fest';
+export declare function checkEnum(value: string, type: ReadonlyDeep<Enum>, ref?: string): Result;

package/lib/enum.js

@@ -9,7 +9,7 @@ function checkEnum(value, type, ref) {
     if (!disallowToSurroundBySpaces) {
         value = value.trim();
     }
-    let values = type.enum;
+    let values = type.enum.slice();
     if (caseInsensitive) {
         value = value.toLowerCase();
         values = type.enum.map(v => v.toLowerCase());

package/lib/get-candidate.d.ts

@@ -1,3 +1,6 @@
 type NullableString = string | null | undefined;
-export declare function getCandidate(value: NullableString, ...candidates: (NullableString | 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.d.ts

@@ -1,3 +1,4 @@
 import type { Result } from './types';
 import type { List } from './types.schema';
-export declare function checkList(value: string, type: List, ref?: string, cache?: boolean): Result;
+import type { ReadonlyDeep } from 'type-fest';
+export declare function checkList(value: string, type: ReadonlyDeep<List>, ref?: string, cache?: boolean): Result;

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,