@markuplint/types 3.0.0-dev.25 → 3.0.0-dev.38

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/types",
-	"version": "3.0.0-dev.25+a27e39aa",
+	"version": "3.0.0-dev.38+b959e06f",
 	"description": "Type declaration and value checker",
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
@@ -31,5 +31,5 @@
 		"@types/debug": "^4.1.7",
 		"@types/whatwg-mimetype": "2"
 	},
-	"gitHead": "a27e39aa4362bce572d1893df2f1571705b62df1"
+	"gitHead": "b959e06f4838b3e6798c990427e22422efe8e699"
 }

package/gen/specific-schema.json

@@ -1,98 +0,0 @@
-{
-	"$schema": "http://json-schema.org/draft-07/schema#",
-	"definitions": {
-		"list": {
-			"description": "- [Space-separated tokens](https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#space-separated-tokens)\n- [Comma-separated tokens](https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#comma-separated-tokens)",
-			"type": "object",
-			"additionalProperties": false,
-			"required": ["token", "separator"],
-			"properties": {
-				"token": {
-					"oneOf": [
-						{
-							"$ref": "#/definitions/extended-type"
-						},
-						{
-							"$ref": "#/definitions/enum"
-						}
-					]
-				},
-				"disallowToSurroundBySpaces": { "type": "boolean" },
-				"allowEmpty": { "type": "boolean" },
-				"ordered": { "type": "boolean" },
-				"unique": { "type": "boolean" },
-				"caseInsensitive": { "type": "boolean" },
-				"number": {
-					"oneOf": [
-						{
-							"type": "string",
-							"enum": ["zeroOrMore", "oneOrMore"]
-						},
-						{
-							"type": "object",
-							"additionalProperties": false,
-							"required": ["min", "max"],
-							"properties": {
-								"min": { "type": "number" },
-								"max": { "type": "number" }
-							}
-						}
-					]
-				},
-				"separator": {
-					"type": "string",
-					"enum": ["space", "comma"]
-				}
-			}
-		},
-		"enum": {
-			"description": "[Enumerated attributes](https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#enumerated-attribute)",
-			"type": "object",
-			"additionalProperties": false,
-			"required": ["enum"],
-			"properties": {
-				"enum": {
-					"type": "array",
-					"minItems": 1,
-					"uniqueItems": true,
-					"items": {
-						"type": "string"
-					}
-				},
-				"disallowToSurroundBySpaces": { "type": "boolean" },
-				"caseInsensitive": { "type": "boolean" },
-				"invalidValueDefault": { "type": "string" },
-				"missingValueDefault": { "type": "string" },
-				"sameStates": {
-					"type": "object",
-					"additionalProperties": true,
-					"patternProperties": {
-						".*": {
-							"type": "array",
-							"minItems": 1,
-							"uniqueItems": true,
-							"items": { "type": "string" }
-						}
-					}
-				}
-			}
-		},
-		"number": {
-			"description": "[Numbers](https://html.spec.whatwg.org/dev/common-microsyntaxes.html#numbers)",
-			"type": "object",
-			"required": ["type"],
-			"additionalProperties": false,
-			"properties": {
-				"type": {
-					"type": "string",
-					"enum": ["float", "integer"]
-				},
-				"gt": { "type": "number" },
-				"gte": { "type": "number" },
-				"lt": { "type": "number" },
-				"lte": { "type": "number" },
-				"clampable": { "type": "boolean" }
-			}
-		}
-	}
-}

package/gen/types.ts

@@ -1,66 +0,0 @@
-import fs from 'fs';
-import path from 'path';
-
-// @ts-ignore
-import { lexer } from 'css-tree';
-
-import { types as extendedTypes, tokenizers } from '../src/defs';
-
-const props = Object.keys(lexer.properties).map(p => `<'${p}'>`);
-const types = Object.keys(lexer.types).map(t => `<${t}>`);
-
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const specific = require('./specific-schema.json');
-
-fs.writeFileSync(
-	path.resolve(__dirname, '..', 'types.schema.json'),
-	JSON.stringify({
-		$schema: 'http://json-schema.org/draft-07/schema#',
-		type: 'object',
-		additionalProperties: false,
-		definitions: {
-			'css-syntax': {
-				type: 'string',
-				enum: [...Array.from(new Set([...props, ...types])), ...Object.keys(tokenizers).map(t => `<${t}>`)],
-			},
-			'extended-type': {
-				type: 'string',
-				enum: Object.keys(extendedTypes),
-			},
-			'html-attr-requirement': {
-				type: 'string',
-				enum: ['Boolean'],
-			},
-			'keyword-defined-type': {
-				...oneOf(
-					//
-					'css-syntax',
-					'extended-type',
-					'html-attr-requirement',
-				),
-			},
-			...specific.definitions,
-			type: {
-				...oneOf(
-					//
-					'keyword-defined-type',
-					...Object.keys(specific.definitions),
-				),
-			},
-		},
-		properties: {
-			type: {
-				$ref: '#/definitions/type',
-			},
-		},
-	}),
-	{ encoding: 'utf-8' },
-);
-
-function oneOf(...keys: string[]) {
-	return {
-		oneOf: keys.map(key => ({
-			$ref: `#/definitions/${key}`,
-		})),
-	};
-}

package/src/check-multi-types.ts

@@ -1,35 +0,0 @@
-import type { CustomSyntaxCheck, UnmatchedResult } from './types';
-
-import { log } from './debug';
-import { matched } from './match-result';
-
-export function checkMultiTypes(value: string, checks: CustomSyntaxCheck[]) {
-	let unmatched: UnmatchedResult | undefined;
-
-	for (const check of checks) {
-		const res = check(value);
-		if (res.matched) {
-			return res;
-		}
-
-		// @ts-ignore
-		res._fn = check.name;
-
-		// @ts-ignore
-		log('%s(%d) vs %s(%d)', unmatched?._fn, unmatched?.passCount, res._fn, res.passCount);
-		const passedA = unmatched?.passCount || 0;
-		const passedB = res.passCount || 0;
-		const offsetA = unmatched?.offset || 0;
-		const offsetB = res.offset;
-
-		if (passedA < passedB || (passedA === passedB && offsetA <= offsetB)) {
-			unmatched = res;
-		}
-	}
-
-	const result = unmatched || matched();
-
-	log('%d checks result: %O', checks.length, result);
-
-	return result;
-}

package/src/check.spec.ts

@@ -1,83 +0,0 @@
-import { check } from './check';
-
-test('Any', () => {
-	expect(check('', 'Any').matched).toBe(true);
-	expect(check(' ', 'Any').matched).toBe(true);
-	expect(check('a', 'Any').matched).toBe(true);
-});
-
-test('NoEmptyAny', () => {
-	expect(check('', 'NoEmptyAny').matched).toBe(false);
-	expect(check(' ', 'NoEmptyAny').matched).toBe(true);
-	expect(check('a', 'NoEmptyAny').matched).toBe(true);
-});
-
-test('OneLineAny', () => {
-	expect(check('', 'OneLineAny').matched).toBe(true);
-	expect(check(' ', 'OneLineAny').matched).toBe(true);
-	expect(check('a', 'OneLineAny').matched).toBe(true);
-	expect(check('a ', 'OneLineAny').matched).toBe(true);
-	expect(check('a b', 'OneLineAny').matched).toBe(true);
-	expect(check('a\n', 'OneLineAny').matched).toBe(false);
-	expect(check('a\nb', 'OneLineAny').matched).toBe(false);
-	expect(check('a\r\nb', 'OneLineAny').matched).toBe(false);
-	expect(check('a\rb', 'OneLineAny').matched).toBe(false);
-});
-
-test('Pattern', () => {
-	expect(check('.*', 'Pattern').matched).toBe(true);
-	expect(check('[a-z]+', 'Pattern').matched).toBe(true);
-	expect(check(']//[()?!+*', 'Pattern').matched).toBe(false);
-});
-
-test('BCP47', () => {
-	expect(check('en', 'BCP47').matched).toBe(true);
-	expect(check('en-US', 'BCP47').matched).toBe(true);
-	expect(check('ja', 'BCP47').matched).toBe(true);
-	expect(check(' ja ', 'BCP47').matched).toBe(false);
-	expect(check('', 'BCP47').matched).toBe(false);
-	expect(check('zh/cn', 'BCP47').matched).toBe(false);
-});
-
-test('Srcset', () => {
-	expect(check('a/bb/ccc/dddd', 'Srcset').matched).toBe(true);
-	expect(check('a/bb/ccc/dddd 200w', 'Srcset').matched).toBe(true);
-	expect(check('a/bb/ccc/dddd 200w, b/cc/ddd/eeee 1.5x', 'Srcset').matched).toBe(true);
-	expect(check('a/bb/ccc/dddd 200w, b/cc/ddd/eeee 1.5a', 'Srcset').matched).toBe(false);
-});
-
-test('IconSize', () => {
-	expect(check('any', 'IconSize').matched).toBe(true);
-	expect(check('Any', 'IconSize').matched).toBe(true);
-	expect(check('10x10', 'IconSize').matched).toBe(true);
-	expect(check('1x1', 'IconSize').matched).toBe(true);
-	expect(check('1x0', 'IconSize').matched).toBe(false);
-	expect(check('0x1', 'IconSize').matched).toBe(false);
-	expect(check('0x0', 'IconSize').matched).toBe(false);
-	expect(check('', 'IconSize').matched).toBe(false);
-	expect(check(' ', 'IconSize').matched).toBe(false);
-	expect(check('1', 'IconSize').matched).toBe(false);
-	expect(check('1x', 'IconSize').matched).toBe(false);
-	expect(check('x1', 'IconSize').matched).toBe(false);
-});
-
-test('Number', () => {
-	expect(check('10', { type: 'integer', gt: 0 }).matched).toBe(true);
-	expect(check('0', { type: 'integer', gt: 0 }).matched).toBe(false);
-	expect(check('0', { type: 'integer', gte: 0 }).matched).toBe(true);
-	expect(check('9', { type: 'integer', lt: 10 }).matched).toBe(true);
-	expect(check('10', { type: 'integer', lt: 10 }).matched).toBe(false);
-});
-
-test('Non-exist types', () => {
-	// @ts-ignore
-	expect(check('abc', 'String').matched).toBe(true);
-	// @ts-ignore
-	expect(check('abc', 'FooBar').matched).toBe(true);
-	// @ts-ignore
-	expect(check('abc', ' ').matched).toBe(true);
-	// @ts-ignore
-	expect(check('abc', '\n').matched).toBe(true);
-	// @ts-ignore
-	expect(check('abc', '').matched).toBe(true);
-});

package/src/check.ts

@@ -1,48 +0,0 @@
-import type { Type, Result, List, CustomSyntax, CustomCssSyntax, Enum, KeywordDefinedType, Number } from './types';
-
-import { log } from './debug';
-import { checkEnum } from './enum';
-import { checkKeywordType } from './keyword-type';
-import { checkList } from './list';
-import { checkNumber } from './number';
-
-export function check(value: string, type: Type, ref?: string, cache = true): Result {
-	if (isKeyword(type)) {
-		log('Check keyword: %s', type);
-		return checkKeywordType(value, type, cache);
-	}
-	if (isList(type)) {
-		log('Check list: %O', type);
-		return checkList(value, type, ref, cache);
-	}
-	if (isEnum(type)) {
-		log('Check enum: %O', type);
-		return checkEnum(value, type, ref);
-	}
-	log('Check number: %O', type);
-	return checkNumber(value, type, ref);
-}
-
-export function isKeyword(type: Type): type is KeywordDefinedType {
-	return typeof type === 'string';
-}
-
-export function isList(type: Type): type is List {
-	return typeof type !== 'string' && 'token' in type;
-}
-
-export function isEnum(type: Type): type is Enum {
-	return typeof type !== 'string' && 'enum' in type;
-}
-
-export function isNumber(type: Type): type is Number {
-	return typeof type !== 'string' && 'enum' in type;
-}
-
-export function isCSSSyntax(type: CustomSyntax | CustomCssSyntax): type is CustomCssSyntax {
-	return typeof type === 'string' || 'syntax' in type;
-}
-
-export function isCustomSyntax(type: CustomSyntax | CustomCssSyntax): type is CustomSyntax {
-	return !isCSSSyntax(type);
-}

package/src/css-syntax.spec.ts

@@ -1,167 +0,0 @@
-import type { CustomCssSyntax } from './types';
-
-import { cssSyntaxMatch } from './css-syntax';
-
-test('CSS Standard', () => {
-	expect(cssSyntaxMatch('10px', '<length>').matched).toBe(true);
-	expect(cssSyntaxMatch('one-pixel', '<length>').matched).toBe(false);
-	expect(cssSyntaxMatch('(prefers-color-scheme: dark)', '<media-query-list>').matched).toBe(true);
-});
-
-test('Extends', () => {
-	const sourceSizeList: CustomCssSyntax = {
-		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(cssSyntaxMatch('50vw', sourceSizeList).matched).toBe(true);
-	expect(cssSyntaxMatch('(max-width: 600px) 200px, 50vw', sourceSizeList).matched).toBe(true);
-	expect(cssSyntaxMatch('print 300vw', sourceSizeList).matched).toBe(false);
-	expect(cssSyntaxMatch('(max-width: 600px) 200px', sourceSizeList).matched).toBe(false);
-	expect(
-		cssSyntaxMatch('(max-width: 600px) 200px', {
-			...sourceSizeList,
-			syntax: {
-				...sourceSizeList.syntax,
-				apply: '<source-size>',
-			},
-		}).matched,
-	).toBe(true);
-
-	const keyTimes: CustomCssSyntax = {
-		ref: 'https://svgwg.org/specs/animations/#KeyTimesAttribute',
-		syntax: {
-			apply: '<key-times>',
-			def: {
-				'key-times': '<number> [; <number>]* [;]?',
-			},
-		},
-	};
-	expect(cssSyntaxMatch('20; 20; 30', keyTimes).matched).toBe(true);
-	expect(cssSyntaxMatch('20; 20; 30;', keyTimes).matched).toBe(true);
-	expect(cssSyntaxMatch('20; 20; abc;', keyTimes).matched).toBe(false);
-	expect(cssSyntaxMatch('20; 20; ;', keyTimes).matched).toBe(false);
-
-	const SVGViewBox: CustomCssSyntax = {
-		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(cssSyntaxMatch('0 0 30 10', SVGViewBox).matched).toBe(true);
-	expect(cssSyntaxMatch('0 0, 30, 10', SVGViewBox).matched).toBe(true);
-	expect(cssSyntaxMatch('0 0, 30', SVGViewBox).matched).toBe(false);
-
-	const percentageList: CustomCssSyntax = {
-		ref: 'https://developer.mozilla.org/en-US/docs/Web/SVG/Content_type#percentage',
-		syntax: {
-			apply: '<percentage-list>',
-			def: {
-				'percentage-list': '[ <number> [,]? ]* <number>',
-			},
-		},
-	};
-	expect(cssSyntaxMatch('0 0 30 10', percentageList).matched).toBe(true);
-	expect(cssSyntaxMatch('0, 0, 30 10', percentageList).matched).toBe(true);
-	expect(cssSyntaxMatch('0', percentageList).matched).toBe(true);
-	expect(cssSyntaxMatch('', percentageList).matched).toBe(false);
-
-	const custom: CustomCssSyntax = {
-		ref: 'n/a',
-		syntax: {
-			apply: '<custom>',
-			def: {
-				custom: '0 | 1 | .',
-			},
-		},
-	};
-	expect(cssSyntaxMatch('0', custom).matched).toBe(true);
-	expect(cssSyntaxMatch('1', custom).matched).toBe(true);
-	expect(cssSyntaxMatch('.', custom).matched).toBe(true);
-	expect(cssSyntaxMatch('2', custom).matched).toBe(false);
-	expect(cssSyntaxMatch(':', custom).matched).toBe(false);
-});
-
-test('custom-type-checking', () => {
-	const custom: CustomCssSyntax = {
-		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(cssSyntaxMatch('1', custom).matched).toBe(true);
-	expect(cssSyntaxMatch('0', custom).matched).toBe(false);
-});
-
-test('case-sensitive', () => {
-	const custom: CustomCssSyntax = {
-		ref: 'n/a',
-		caseSensitive: true,
-		syntax: {
-			apply: '<custom>',
-			def: {
-				custom: 'CaSeS [a | B | aBc]',
-			},
-		},
-	};
-	expect(cssSyntaxMatch('CaSeS a', custom).matched).toBe(true);
-	expect(cssSyntaxMatch('CaSeS B', custom).matched).toBe(true);
-	expect(cssSyntaxMatch('CaSeS aBc', custom).matched).toBe(true);
-	expect(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(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 ]',
-			},
-		],
-	});
-});