@markuplint/types 3.0.0-alpha.6 → 3.0.0-dev.176

package/README.md

@@ -1,18 +1,14 @@
 # @markuplint/types
 
 [![npm version](https://badge.fury.io/js/%40markuplint%2Ftypes.svg)](https://www.npmjs.com/package/@markuplint/types)
-[![Build Status](https://travis-ci.org/markuplint/markuplint.svg?branch=main)](https://travis-ci.org/markuplint/markuplint)
-[![Coverage Status](https://coveralls.io/repos/github/markuplint/markuplint/badge.svg?branch=main)](https://coveralls.io/github/markuplint/markuplint?branch=main)
 
-## Install
+**Type declaration and value checker**
 
-```sh
-$ npm install @markuplint/types
+## Type declaration
 
-$ yarn add @markuplint/types
-```
+- [types.schema.json](./types.schema.json)
 
-## Usage
+## API
 
 ```ts
 import { check } from '@markuplint/types';
@@ -100,3 +96,11 @@ check('2020-02-30', 'DateTime');
 | `<number-optional-number>`     | Some attributes for SVG             |                                                                                                                    | ✅        |
 
 In addition, you can use types **[CSSTree](https://github.com/csstree/csstree)** defined.
+
+## Install
+
+```shell
+$ npm install @markuplint/types
+
+$ yarn add @markuplint/types
+```

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

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

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.d.ts

@@ -1,8 +1,9 @@
 import type { Type, Result, List, CustomSyntax, CustomCssSyntax, Enum, KeywordDefinedType, Number } from './types';
-export declare function check(value: string, type: Type, ref?: string, cache?: boolean): Result;
-export declare function isKeyword(type: Type): type is KeywordDefinedType;
-export declare function isList(type: Type): type is List;
-export declare function isEnum(type: Type): type is Enum;
-export declare function isNumber(type: Type): type is Number;
+import type { ReadonlyDeep } from 'type-fest';
+export declare function check(value: string, type: ReadonlyDeep<Type>, ref?: string, cache?: boolean): Result;
+export declare function isKeyword(type: ReadonlyDeep<Type>): type is ReadonlyDeep<KeywordDefinedType>;
+export declare function isList(type: ReadonlyDeep<Type>): type is ReadonlyDeep<List>;
+export declare function isEnum(type: ReadonlyDeep<Type>): type is ReadonlyDeep<Enum>;
+export declare function isNumber(type: ReadonlyDeep<Type>): type is ReadonlyDeep<Number>;
 export declare function isCSSSyntax(type: CustomSyntax | CustomCssSyntax): type is CustomCssSyntax;
 export declare function isCustomSyntax(type: CustomSyntax | CustomCssSyntax): type is CustomSyntax;

package/lib/check.spec.js

@@ -1,76 +1,82 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const check_1 = require("./check");
+'use strict';
+// @ts-nocheck
+Object.defineProperty(exports, '__esModule', { value: true });
+const check_1 = require('./check');
 test('Any', () => {
-    expect((0, check_1.check)('', 'Any').matched).toBe(true);
-    expect((0, check_1.check)(' ', 'Any').matched).toBe(true);
-    expect((0, check_1.check)('a', 'Any').matched).toBe(true);
+	expect((0, check_1.check)('', 'Any').matched).toBe(true);
+	expect((0, check_1.check)(' ', 'Any').matched).toBe(true);
+	expect((0, check_1.check)('a', 'Any').matched).toBe(true);
 });
 test('NoEmptyAny', () => {
-    expect((0, check_1.check)('', 'NoEmptyAny').matched).toBe(false);
-    expect((0, check_1.check)(' ', 'NoEmptyAny').matched).toBe(true);
-    expect((0, check_1.check)('a', 'NoEmptyAny').matched).toBe(true);
+	expect((0, check_1.check)('', 'NoEmptyAny').matched).toBe(false);
+	expect((0, check_1.check)(' ', 'NoEmptyAny').matched).toBe(true);
+	expect((0, check_1.check)('a', 'NoEmptyAny').matched).toBe(true);
 });
 test('OneLineAny', () => {
-    expect((0, check_1.check)('', 'OneLineAny').matched).toBe(true);
-    expect((0, check_1.check)(' ', 'OneLineAny').matched).toBe(true);
-    expect((0, check_1.check)('a', 'OneLineAny').matched).toBe(true);
-    expect((0, check_1.check)('a ', 'OneLineAny').matched).toBe(true);
-    expect((0, check_1.check)('a b', 'OneLineAny').matched).toBe(true);
-    expect((0, check_1.check)('a\n', 'OneLineAny').matched).toBe(false);
-    expect((0, check_1.check)('a\nb', 'OneLineAny').matched).toBe(false);
-    expect((0, check_1.check)('a\r\nb', 'OneLineAny').matched).toBe(false);
-    expect((0, check_1.check)('a\rb', 'OneLineAny').matched).toBe(false);
+	expect((0, check_1.check)('', 'OneLineAny').matched).toBe(true);
+	expect((0, check_1.check)(' ', 'OneLineAny').matched).toBe(true);
+	expect((0, check_1.check)('a', 'OneLineAny').matched).toBe(true);
+	expect((0, check_1.check)('a ', 'OneLineAny').matched).toBe(true);
+	expect((0, check_1.check)('a b', 'OneLineAny').matched).toBe(true);
+	expect((0, check_1.check)('a\n', 'OneLineAny').matched).toBe(false);
+	expect((0, check_1.check)('a\nb', 'OneLineAny').matched).toBe(false);
+	expect((0, check_1.check)('a\r\nb', 'OneLineAny').matched).toBe(false);
+	expect((0, check_1.check)('a\rb', 'OneLineAny').matched).toBe(false);
 });
 test('Pattern', () => {
-    expect((0, check_1.check)('.*', 'Pattern').matched).toBe(true);
-    expect((0, check_1.check)('[a-z]+', 'Pattern').matched).toBe(true);
-    expect((0, check_1.check)(']//[()?!+*', 'Pattern').matched).toBe(false);
+	expect((0, check_1.check)('.*', 'Pattern').matched).toBe(true);
+	expect((0, check_1.check)('[a-z]+', 'Pattern').matched).toBe(true);
+	expect((0, check_1.check)(']//[()?!+*', 'Pattern').matched).toBe(false);
 });
 test('BCP47', () => {
-    expect((0, check_1.check)('en', 'BCP47').matched).toBe(true);
-    expect((0, check_1.check)('en-US', 'BCP47').matched).toBe(true);
-    expect((0, check_1.check)('ja', 'BCP47').matched).toBe(true);
-    expect((0, check_1.check)(' ja ', 'BCP47').matched).toBe(false);
-    expect((0, check_1.check)('', 'BCP47').matched).toBe(false);
-    expect((0, check_1.check)('zh/cn', 'BCP47').matched).toBe(false);
+	expect((0, check_1.check)('en', 'BCP47').matched).toBe(true);
+	expect((0, check_1.check)('en-US', 'BCP47').matched).toBe(true);
+	expect((0, check_1.check)('ja', 'BCP47').matched).toBe(true);
+	expect((0, check_1.check)(' ja ', 'BCP47').matched).toBe(false);
+	expect((0, check_1.check)('', 'BCP47').matched).toBe(false);
+	expect((0, check_1.check)('zh/cn', 'BCP47').matched).toBe(false);
 });
 test('Srcset', () => {
-    expect((0, check_1.check)('a/bb/ccc/dddd', 'Srcset').matched).toBe(true);
-    expect((0, check_1.check)('a/bb/ccc/dddd 200w', 'Srcset').matched).toBe(true);
-    expect((0, check_1.check)('a/bb/ccc/dddd 200w, b/cc/ddd/eeee 1.5x', 'Srcset').matched).toBe(true);
-    expect((0, check_1.check)('a/bb/ccc/dddd 200w, b/cc/ddd/eeee 1.5a', 'Srcset').matched).toBe(false);
+	expect((0, check_1.check)('a/bb/ccc/dddd', 'Srcset').matched).toBe(true);
+	expect((0, check_1.check)('a/bb/ccc/dddd 200w', 'Srcset').matched).toBe(true);
+	expect((0, check_1.check)('a/bb/ccc/dddd 200w, b/cc/ddd/eeee 1.5x', 'Srcset').matched).toBe(true);
+	expect((0, check_1.check)('a/bb/ccc/dddd 200w, b/cc/ddd/eeee 1.5a', 'Srcset').matched).toBe(false);
 });
 test('IconSize', () => {
-    expect((0, check_1.check)('any', 'IconSize').matched).toBe(true);
-    expect((0, check_1.check)('Any', 'IconSize').matched).toBe(true);
-    expect((0, check_1.check)('10x10', 'IconSize').matched).toBe(true);
-    expect((0, check_1.check)('1x1', 'IconSize').matched).toBe(true);
-    expect((0, check_1.check)('1x0', 'IconSize').matched).toBe(false);
-    expect((0, check_1.check)('0x1', 'IconSize').matched).toBe(false);
-    expect((0, check_1.check)('0x0', 'IconSize').matched).toBe(false);
-    expect((0, check_1.check)('', 'IconSize').matched).toBe(false);
-    expect((0, check_1.check)(' ', 'IconSize').matched).toBe(false);
-    expect((0, check_1.check)('1', 'IconSize').matched).toBe(false);
-    expect((0, check_1.check)('1x', 'IconSize').matched).toBe(false);
-    expect((0, check_1.check)('x1', 'IconSize').matched).toBe(false);
+	expect((0, check_1.check)('any', 'IconSize').matched).toBe(true);
+	expect((0, check_1.check)('Any', 'IconSize').matched).toBe(true);
+	expect((0, check_1.check)('10x10', 'IconSize').matched).toBe(true);
+	expect((0, check_1.check)('1x1', 'IconSize').matched).toBe(true);
+	expect((0, check_1.check)('1x0', 'IconSize').matched).toBe(false);
+	expect((0, check_1.check)('0x1', 'IconSize').matched).toBe(false);
+	expect((0, check_1.check)('0x0', 'IconSize').matched).toBe(false);
+	expect((0, check_1.check)('', 'IconSize').matched).toBe(false);
+	expect((0, check_1.check)(' ', 'IconSize').matched).toBe(false);
+	expect((0, check_1.check)('1', 'IconSize').matched).toBe(false);
+	expect((0, check_1.check)('1x', 'IconSize').matched).toBe(false);
+	expect((0, check_1.check)('x1', 'IconSize').matched).toBe(false);
 });
 test('Number', () => {
-    expect((0, check_1.check)('10', { type: 'integer', gt: 0 }).matched).toBe(true);
-    expect((0, check_1.check)('0', { type: 'integer', gt: 0 }).matched).toBe(false);
-    expect((0, check_1.check)('0', { type: 'integer', gte: 0 }).matched).toBe(true);
-    expect((0, check_1.check)('9', { type: 'integer', lt: 10 }).matched).toBe(true);
-    expect((0, check_1.check)('10', { type: 'integer', lt: 10 }).matched).toBe(false);
+	expect((0, check_1.check)('10', { type: 'integer', gt: 0 }).matched).toBe(true);
+	expect((0, check_1.check)('0', { type: 'integer', gt: 0 }).matched).toBe(false);
+	expect((0, check_1.check)('0', { type: 'integer', gte: 0 }).matched).toBe(true);
+	expect((0, check_1.check)('9', { type: 'integer', lt: 10 }).matched).toBe(true);
+	expect((0, check_1.check)('10', { type: 'integer', lt: 10 }).matched).toBe(false);
 });
 test('Non-exist types', () => {
-    // @ts-ignore
-    expect((0, check_1.check)('abc', 'String').matched).toBe(true);
-    // @ts-ignore
-    expect((0, check_1.check)('abc', 'FooBar').matched).toBe(true);
-    // @ts-ignore
-    expect((0, check_1.check)('abc', ' ').matched).toBe(true);
-    // @ts-ignore
-    expect((0, check_1.check)('abc', '\n').matched).toBe(true);
-    // @ts-ignore
-    expect((0, check_1.check)('abc', '').matched).toBe(true);
+	// @ts-ignore
+	expect((0, check_1.check)('abc', 'String').matched).toBe(true);
+	// @ts-ignore
+	expect((0, check_1.check)('abc', 'FooBar').matched).toBe(true);
+	// @ts-ignore
+	expect((0, check_1.check)('abc', ' ').matched).toBe(true);
+	// @ts-ignore
+	expect((0, check_1.check)('abc', '\n').matched).toBe(true);
+	// @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

@@ -1,19 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.cssSyntaxMatch = void 0;
-const tslib_1 = require("tslib");
-// @ts-ignore
-const css_tree_1 = tslib_1.__importDefault(require("css-tree"));
-// @ts-ignore
-const error_js_1 = require("css-tree/lib/lexer/error.js");
-// @ts-ignore
-const match_js_1 = require("css-tree/lib/lexer/match.js");
-// @ts-ignore
-const prepare_tokens_js_1 = tslib_1.__importDefault(require("css-tree/lib/lexer/prepare-tokens.js"));
+const css_tree_1 = require("css-tree");
 const debug_1 = require("./debug");
 const defs_1 = require("./defs");
 const match_result_1 = require("./match-result");
+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;
@@ -29,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)();
@@ -43,7 +39,7 @@ function cssSyntaxMatch(value, type) {
             if (typeof valueOrChecker === 'string') {
                 typesExtended[key] = valueOrChecker;
             }
-            else {
+            else if (valueOrChecker) {
                 typesCheckers[key] = valueOrChecker;
             }
         });
@@ -57,52 +53,51 @@ function cssSyntaxMatch(value, type) {
         ref = type.ref;
     }
     // @ts-ignore
-    const lexer = css_tree_1.default.fork({
+    const lexer = (0, css_tree_1.fork)({
         types: typesExtended,
         properties: propsExtended,
     }).lexer;
     Object.keys(typesCheckers).forEach(key => {
         const checker = typesCheckers[key];
-        lexer.addType_(key, (token, getNextToken) => checker(token, getNextToken, cssSyntaxMatch));
+        // @ts-ignore
+        lexer.addType_(key, (token, getNextToken) => checker === null || checker === void 0 ? void 0 : checker(token, getNextToken, cssSyntaxMatch));
     });
-    const { isProp, name, matcher } = defToMatcher(lexer, defName);
+    const { isProp, name } = detectName(defName);
+    // @ts-ignore
+    const matcher = isProp ? lexer.properties[name] : lexer.types[name];
+    if (!matcher) {
+        (0, debug_1.log)('"%s" CSS syntax not found', defName);
+        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) {
         // eslint-disable-next-line no-console
         console.warn = warn => (0, debug_1.log)('WARNING: %s (by %s => %s)', warn, value, type);
     }
-    const tokens = (0, prepare_tokens_js_1.default)(value, lexer.syntax);
-    const result = (0, match_js_1.matchAsTree)(tokens, matcher.match, lexer);
-    if (caseSensitive) {
-        if (result.tokens && Array.isArray(result.tokens)) {
-            let reducer = 0;
-            result.tokens = result.tokens.map((token) => {
-                const value = token.value;
-                const originValue = deMimicCases(value || '');
-                const isMimiced = value !== originValue;
-                reducer += isMimiced ? 'mimiccases------mimiccases'.length : 0;
-                token.value = originValue;
-                token.balance = token.balance - reducer;
-                return token;
-            });
-        }
-    }
+    const result = lexer.match(defName, value);
     (0, debug_1.log)('css-tree/result: %O', result);
     // eslint-disable-next-line no-console
     console.warn = _w;
-    if (result.match) {
-        if (debug_1.log.enabled) {
-            (0, debug_1.log)('css-tree/result.match: %s', JSON.stringify(result.match, null, 2));
-        }
+    if (!result.error) {
         return (0, match_result_1.matched)();
     }
-    const error = new error_js_1.SyntaxMatchError(result.reason, matcher.syntax, value, result);
+    if (!('css' in result.error)) {
+        throw result.error;
+    }
+    const error = result.error;
     if (caseSensitive) {
-        error.message = deMimicCases(error.message);
+        const offset = error.mismatchOffset % MIMIC_LENGTH;
+        const diff = error.mismatchOffset - offset;
+        error.message = deMimicCases(error.message).replace('-'.repeat(diff), '');
         error.syntax = deMimicCases(error.syntax);
+        error.css = deMimicCases(error.css);
+        error.mismatchOffset = offset;
+        error.column = error.column % MIMIC_LENGTH;
+        const mismatchLength = error.mismatchLength - MIMIC_LENGTH;
+        error.mismatchLength = mismatchLength < 0 ? error.mismatchLength : mismatchLength;
     }
     (0, debug_1.log)('css-tree/SyntaxMatchError: %O', error);
     return {
@@ -124,27 +119,34 @@ function cssSyntaxMatch(value, type) {
     };
 }
 exports.cssSyntaxMatch = cssSyntaxMatch;
-function defToMatcher(lexer, def) {
+function detectName(def) {
     const isProp = def.search("<'") === 0;
     const name = def.replace(/^<'?|'?>$/g, '');
-    const matcher = isProp ? lexer.properties[name] : lexer.types[name];
-    if (!matcher) {
-        (0, debug_1.log)('"%s" CSS syntax not found', def);
-        throw new Error('MARKUPLINT_TYPE_NO_EXIST');
-    }
     return {
         isProp,
         name,
-        matcher,
     };
 }
-function eachMimicCases(key, obj) {
+/**
+ *
+ * @param key
+ * @param obj
+ * @modifies obj
+ * @returns
+ */
+function eachMimicCases(key, 
+// Mutable
+// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+obj) {
     const value = obj[key];
+    if (!value) {
+        return;
+    }
     obj[key] = mimicCases(value);
 }
 function mimicCases(value) {
-    return value.replace(/[A-Z]/g, $0 => `mimiccases---${$0}---mimiccases`);
+    return value.replace(/[A-Z]/g, $0 => `${MIMIC_TAG_L}${$0}${MIMIC_TAG_R}`);
 }
 function deMimicCases(value) {
-    return value.replace(/mimiccases---([A-Z])---mimiccases/g, (_, $1) => $1);
+    return value.replace(new RegExp(`${MIMIC_TAG_L}([A-Z])${MIMIC_TAG_R}`, 'g'), (_, $1) => $1);
 }