@markuplint/types 4.0.0-dev.28 → 4.0.0-rc.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017-2019 Yusuke Hirao
+Copyright (c) 2017-2024 Yusuke Hirao
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

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

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

package/lib/css-syntax.js

@@ -1,6 +1,6 @@
 import { fork } from 'css-tree';
 import { log } from './debug.js';
-import { tokenizers } from './defs.js';
+import { tokenizers, overrides } from './defs.js';
 import { matched } from './match-result.js';
 const MIMIC_TAG_L = 'mimiccases---';
 const MIMIC_TAG_R = '---mimiccases';
@@ -52,7 +52,10 @@ export function cssSyntaxMatch(value, type) {
     }
     // @ts-ignore
     const lexer = fork({
-        types: typesExtended,
+        types: {
+            ...overrides,
+            ...typesExtended,
+        },
         properties: propsExtended,
     }).lexer;
     for (const key of Object.keys(typesCheckers)) {

package/lib/defs.d.ts

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

package/lib/defs.js

@@ -88,12 +88,14 @@ export const types = {
             },
         ],
         is: value => {
-            // NameStartChar ::= ":" | [A-Z] | "_" | [a-z] | [#xC0-#xD6] | [#xD8-#xF6] | [#xF8-#x2FF] | [#x370-#x37D] | [#x37F-#x1FFF] | [#x200C-#x200D] | [#x2070-#x218F] | [#x2C00-#x2FEF] | [#x3001-#xD7FF] | [#xF900-#xFDCF] | [#xFDF0-#xFFFD] | [#x10000-#xEFFFF]
-            const nameStartChar = /[:A-Z_a-z\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u02FF\u0370-\u037D\u037F-\u1FFF\u200C-\u200D\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD\u{10000}-\u{EFFFF}]/u;
-            // NameChar ::= NameStartChar | "-" | "." | [0-9] | #xB7 | [#x0300-#x036F] | [#x203F-#x2040]
-            const nameCharTail = /-|[\d.\u00B7]|[\u0300-\u036F\u203F\u2040]/;
-            // Name ::= NameStartChar (NameChar)*
-            const name = new RegExp(`(?:${nameStartChar.source})(?:${nameCharTail})*`, 'u');
+            /**
+             * NameStartChar ::= ":" | [A-Z] | "_" | [a-z] | [#xC0-#xD6] | [#xD8-#xF6] | [#xF8-#x2FF] | [#x370-#x37D] | [#x37F-#x1FFF] | [#x200C-#x200D] | [#x2070-#x218F] | [#x2C00-#x2FEF] | [#x3001-#xD7FF] | [#xF900-#xFDCF] | [#xFDF0-#xFFFD] | [#x10000-#xEFFFF]
+             * NameChar ::= NameStartChar | "-" | "." | [0-9] | #xB7 | [#x0300-#x036F] | [#x203F-#x2040]
+             * Name ::= NameStartChar (NameChar)*
+             */
+            const name = 
+            // eslint-disable-next-line no-misleading-character-class
+            /[:A-Z_a-z\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u02FF\u0370-\u037D\u037F-\u1FFF\u200C\u200D\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD\u{10000}-\u{EFFFF}][\d.\u00B7\u0300-\u036F\u203F\u2040-]*/u;
             return name.test(value) ? matched() : unmatched(value, 'unexpected-token');
         },
     },
@@ -403,51 +405,81 @@ export const types = {
     },
     Srcset: {
         ref: 'https://html.spec.whatwg.org/multipage/images.html#srcset-attributes',
-        syntax: {
-            apply: '<srcset>',
-            def: {
-                srcset: '<image-candidate-strings> [, <image-candidate-strings>]*',
-                'image-candidate-strings': '<valid-non-empty-url> [ <width-descriptor> | <pixel-density-descriptor> ]?',
-                'valid-non-empty-url'(token, getNextToken) {
-                    if (!token) {
-                        return 0;
-                    }
-                    let willAdoptTokenLength = 0;
-                    do {
-                        if (token.type === 13) {
+        is(value) {
+            const images = value.split(',');
+            for (const image of images) {
+                // image candidate string
+                const [url, , descriptor, ...tail] = new TokenCollection(image.trim(), {
+                    disallowToSurroundBySpaces: true,
+                    separator: 'space',
+                });
+                if (!url) {
+                    return unmatched(value, 'unexpected-token', {
+                        expects: [
+                            {
+                                type: 'format',
+                                value: 'valid non-empty URL',
+                            },
+                        ],
+                    });
+                }
+                if (descriptor) {
+                    const { num, unit } = splitUnit(descriptor.value);
+                    switch (unit) {
+                        case 'w': {
+                            if (!isUint(num)) {
+                                return unmatched(value, 'unexpected-token', {
+                                    expects: [
+                                        {
+                                            type: 'format',
+                                            value: 'width descriptor',
+                                        },
+                                    ],
+                                });
+                            }
                             break;
                         }
-                        willAdoptTokenLength++;
-                    } while ((token = getNextToken(willAdoptTokenLength)));
-                    return willAdoptTokenLength;
-                },
-                'width-descriptor'(token) {
-                    if (!token) {
-                        return 0;
-                    }
-                    const { num, unit } = splitUnit(token.value);
-                    if (unit !== 'w') {
-                        return 0;
-                    }
-                    if (!isUint(num)) {
-                        return 0;
-                    }
-                    return 1;
-                },
-                'pixel-density-descriptor'(token) {
-                    if (!token) {
-                        return 0;
-                    }
-                    const { num, unit } = splitUnit(token.value);
-                    if (unit !== 'x') {
-                        return 0;
-                    }
-                    if (!isFloat(num)) {
-                        return 0;
+                        case 'x': {
+                            if (!isFloat(num)) {
+                                return unmatched(value, 'unexpected-token', {
+                                    expects: [
+                                        {
+                                            type: 'format',
+                                            value: 'pixel density descriptor',
+                                        },
+                                    ],
+                                });
+                            }
+                            break;
+                        }
+                        default: {
+                            return unmatched(value, 'unexpected-token', {
+                                expects: [
+                                    {
+                                        type: 'format',
+                                        value: 'width descriptor',
+                                    },
+                                    {
+                                        type: 'format',
+                                        value: 'pixel density descriptor',
+                                    },
+                                ],
+                            });
+                        }
                     }
-                    return 1;
-                },
-            },
+                }
+                if (tail[0]) {
+                    return unmatched(value, 'unexpected-token', {
+                        expects: [
+                            {
+                                type: 'syntax',
+                                value: 'image candidate string',
+                            },
+                        ],
+                    });
+                }
+            }
+            return matched();
         },
     },
     SourceSizeList: {
@@ -750,7 +782,7 @@ export const types = {
         syntax: {
             apply: '<view-box>',
             def: {
-                'view-box': '<min-x> [,]? <min-y> [,]? <width> [,]? <height>',
+                'view-box': '<min-x> [,]? <min-y> [,]? <width> [,]? <height>', // As '[<min-x>,? <min-y>,? <width>,? <height>]',
                 'min-x': '<number>',
                 'min-y': '<number>',
                 width: '<number>',
@@ -813,6 +845,27 @@ export const types = {
         },
     },
 };
+export const overrides = {
+    // Alias
+    'legacy-length-percentage': '<length> | <percentage> | <svg-length>',
+    'legacy-angle': '<angle> | <zero> | <number>',
+    /**
+     * @see https://www.w3.org/TR/css-transforms-1/#funcdef-transform-translate
+     */
+    'translate()': 'translate( <legacy-length-percentage> , <legacy-length-percentage>? ) | translate( <legacy-length-percentage> <legacy-length-percentage>? )',
+    /**
+     * @see https://www.w3.org/TR/css-transforms-1/#funcdef-transform-scale
+     */
+    'scale()': 'scale( [ <number> | <percentage> ]#{1,2} )',
+    /**
+     * @see https://www.w3.org/TR/css-transforms-1/#funcdef-transform-rotate
+     */
+    'rotate()': 'rotate( <legacy-angle> )',
+    /**
+     * @see https://www.w3.org/TR/css-transforms-1/#funcdef-transform-skew
+     */
+    'skew()': 'skew( <legacy-angle> , <legacy-angle>? ) | skew( <legacy-angle> <legacy-angle>? )',
+};
 export const tokenizers = {
     // RFC
     // https://tools.ietf.org/rfc/bcp/bcp47.html

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/token/token-collection.d.ts

@@ -24,7 +24,7 @@ export declare class TokenCollection extends Array<Token> {
         expects?: Expect[];
         ref?: string;
         cache?: boolean;
-    }): import("../types.js").MatchedResult | UnmatchedResult;
+    }): UnmatchedResult | import("../types.js").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.js

@@ -1,10 +1,10 @@
 export class Token {
     static getCol(value, offset) {
-        const lines = value.slice(0, offset).split(/\n/g);
+        const lines = value.slice(0, offset).split(/\n/);
         return (lines.at(-1) ?? '').length + 1;
     }
     static getLine(value, offset) {
-        return value.slice(0, offset).split(/\n/g).length;
+        return value.slice(0, offset).split(/\n/).length;
     }
     static getType(value, separators) {
         if (Token.whitespace.includes(value[0] ?? '')) {

package/lib/whatwg/is-custom-element-name.d.ts

@@ -2,7 +2,14 @@ import type { FormattedPrimitiveTypeCreator } from '../types.js';
 /**
  * valid name of custom element
  *
- * @see https://html.spec.whatwg.org/multipage/custom-elements.html#valid-custom-element-name
+ * > PotentialCustomElementName ::=
+ * >   [a-z] (PCENChar)* '-' (PCENChar)*
+ * > PCENChar ::=
+ * >   "-" | "." | [0-9] | "_" | [a-z] | #xB7 | [#xC0-#xD6] | [#xD8-#xF6] | [#xF8-#x37D] |
+ * >   [#x37F-#x1FFF] | [#x200C-#x200D] | [#x203F-#x2040] | [#x2070-#x218F] | [#x2C00-#x2FEF] | [#x3001-#xD7FF] | [#xF900-#xFDCF] | [#xFDF0-#xFFFD] | [#x10000-#xEFFFF]
+ * > This uses the EBNF notation from the XML specification. [XML]
+ *
+ * > They start with an ASCII lower alpha, ensuring that the HTML parser will treat them as tags instead of as text.
  *
  * > - name must match the [PotentialCustomElementName](https://html.spec.whatwg.org/multipage/custom-elements.html#prod-potentialcustomelementname) production
  * > - name must not be any of the following:
@@ -15,8 +22,6 @@ import type { FormattedPrimitiveTypeCreator } from '../types.js';
  * >   - `<font-face-name>`
  * >   - `<missing-glyph>`
  *
- * ASCII-case-insensitively.
- * Originally, it is not possible to define a name including ASCII upper alphas in the custom element, but it is not treated as illegal by the HTML parser.
- *
+ * @see https://html.spec.whatwg.org/multipage/custom-elements.html#valid-custom-element-name
  */
 export declare const isCustomElementName: FormattedPrimitiveTypeCreator;

package/lib/whatwg/is-custom-element-name.js

@@ -1,8 +1,18 @@
 /**
- * PotentialCustomElementName
+ * PCENChar
  *
+ * > PCENChar ::=
+ * >   "-" | "." | [0-9] | "_" | [a-z] | #xB7 | [#xC0-#xD6] | [#xD8-#xF6] | [#xF8-#x37D] |
+ * >   [#x37F-#x1FFF] | [#x200C-#x200D] | [#x203F-#x2040] | [#x2070-#x218F] | [#x2C00-#x2FEF] | [#x3001-#xD7FF] | [#xF900-#xFDCF] | [#xFDF0-#xFFFD] | [#x10000-#xEFFFF]
  * @see https://html.spec.whatwg.org/multipage/custom-elements.html#prod-potentialcustomelementname
  *
+ */
+const onlyPCENChar = 
+// eslint-disable-next-line no-misleading-character-class
+/^[-.\d_a-z\u00B7\u00C0-\u00D6[\u00D8-\u00F6\u00F8-\u037D\u037F-\u1FFF\u200C\u200D\u203F\u2040\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD\u{10000}-\u{EFFFF}]*$/u;
+/**
+ * valid name of custom element
+ *
  * > PotentialCustomElementName ::=
  * >   [a-z] (PCENChar)* '-' (PCENChar)*
  * > PCENChar ::=
@@ -10,34 +20,7 @@
  * >   [#x37F-#x1FFF] | [#x200C-#x200D] | [#x203F-#x2040] | [#x2070-#x218F] | [#x2C00-#x2FEF] | [#x3001-#xD7FF] | [#xF900-#xFDCF] | [#xFDF0-#xFFFD] | [#x10000-#xEFFFF]
  * > This uses the EBNF notation from the XML specification. [XML]
  *
- * ASCII-case-insensitively.
- * Originally, it is not possible to define a name including ASCII upper alphas in the custom element, but it is not treated as illegal by the HTML parser.
- */
-const rePCENChar = [
-    '\\-',
-    '\\.',
-    '[0-9]',
-    '_',
-    '[a-z]',
-    '\u00B7',
-    '[\u00C0-\u00D6]',
-    '[\u00D8-\u00F6]',
-    '[\u00F8-\u037D]',
-    '[\u037F-\u1FFF]',
-    '[\u200C-\u200D]',
-    '[\u203F-\u2040]',
-    '[\u2070-\u218F]',
-    '[\u2C00-\u2FEF]',
-    '[\u3001-\uD7FF]',
-    '[\uF900-\uFDCF]',
-    '[\uFDF0-\uFFFD]',
-    '[\uD800-\uDBFF][\uDC00-\uDFFF]',
-].join('|');
-const rePCEN = new RegExp(`^[a-z](?:${rePCENChar})*\\-(?:${rePCENChar})*$`, 'i');
-/**
- * valid name of custom element
- *
- * @see https://html.spec.whatwg.org/multipage/custom-elements.html#valid-custom-element-name
+ * > They start with an ASCII lower alpha, ensuring that the HTML parser will treat them as tags instead of as text.
  *
  * > - name must match the [PotentialCustomElementName](https://html.spec.whatwg.org/multipage/custom-elements.html#prod-potentialcustomelementname) production
  * > - name must not be any of the following:
@@ -50,9 +33,7 @@ const rePCEN = new RegExp(`^[a-z](?:${rePCENChar})*\\-(?:${rePCENChar})*$`, 'i')
  * >   - `<font-face-name>`
  * >   - `<missing-glyph>`
  *
- * ASCII-case-insensitively.
- * Originally, it is not possible to define a name including ASCII upper alphas in the custom element, but it is not treated as illegal by the HTML parser.
- *
+ * @see https://html.spec.whatwg.org/multipage/custom-elements.html#valid-custom-element-name
  */
 export const isCustomElementName = () => {
     return tagName => {
@@ -68,6 +49,13 @@ export const isCustomElementName = () => {
                 return false;
             }
         }
-        return rePCEN.test(tagName);
+        // First char must be ASCII lowercase alpha.
+        if (!/^[a-z]/.test(tagName)) {
+            return false;
+        }
+        if (!tagName.includes('-')) {
+            return false;
+        }
+        return onlyPCENChar.test(tagName);
     };
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/types",
-	"version": "4.0.0-dev.28+0131de5e",
+	"version": "4.0.0-rc.0",
 	"description": "Type declaration and value checker",
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
@@ -22,18 +22,22 @@
 	"scripts": {
 		"build": "tsc",
 		"clean": "tsc --build --clean",
-		"schema": "ts-node './gen/types.ts'; json2ts './types.schema.json' > './src/types.schema.ts'; prettier './src/types.schema.ts' './types.schema.json' --write; eslint './src/types.schema.ts' --fix; tsc;"
+		"schema": "run-s schema:types schema:schema build schema:prettier schema:eslint schema:prettier",
+		"schema:types": "node --loader ts-node/esm \"./gen/types.ts\"",
+		"schema:schema": "json2ts \"./types.schema.json\" > \"./src/types.schema.ts\"",
+		"schema:eslint": "eslint --fix \"./src/types.schema.ts\"",
+		"schema:prettier": "prettier --write \"./src/types.schema.ts\" \"./types.schema.json\" --log-level warn"
 	},
 	"dependencies": {
-		"@types/css-tree": "^2.3.3",
-		"@types/debug": "^4.1.10",
-		"@types/whatwg-mimetype": "3.0.1",
+		"@types/css-tree": "^2.3.4",
+		"@types/debug": "^4.1.12",
+		"@types/whatwg-mimetype": "3.0.2",
 		"bcp-47": "^2.1.0",
 		"css-tree": "^2.3.1",
 		"debug": "^4.3.4",
 		"leven": "^4.0.0",
-		"type-fest": "^4.5.0",
-		"whatwg-mimetype": "^3.0.0"
+		"type-fest": "^4.10.2",
+		"whatwg-mimetype": "^4.0.0"
 	},
-	"gitHead": "0131de5ea9dd6d3fd5472d7b414b66644c758881"
+	"gitHead": "3fdeb45cb69ed52b3a215a7520cea1181601443f"
 }