@markuplint/types 1.0.0-dev.20211213.0

package/lib/css-syntax.spec.js

@@ -0,0 +1,157 @@
+"use strict";
+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);
+});
+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);
+});
+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);
+});
+test('case-sensivite', () => {
+    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 ]',
+            },
+        ],
+    });
+});

package/lib/debug.d.ts

@@ -0,0 +1,2 @@
+import debug from 'debug';
+export declare const log: debug.Debugger;

package/lib/debug.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.log = void 0;
+const tslib_1 = require("tslib");
+const debug_1 = (0, tslib_1.__importDefault)(require("debug"));
+exports.log = (0, debug_1.default)('@markuplint/types');

package/lib/defs.d.ts

@@ -0,0 +1,3 @@
+import type { Defs, CssSyntaxTokenizer } from './types';
+export declare const types: Defs;
+export declare const tokenizers: Record<string, CssSyntaxTokenizer>;