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

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,2 @@
 import type { CustomSyntaxCheck, UnmatchedResult } from './types';
-export declare function checkMultiTypes(
-	value: string,
-	checks: CustomSyntaxCheck[],
-): import('./types').MatchedResult | UnmatchedResult;
+export declare function checkMultiTypes(value: string, checks: CustomSyntaxCheck[]): import("./types").MatchedResult | UnmatchedResult;

package/lib/css-syntax.js

@@ -5,11 +5,11 @@ 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");
+const error_1 = require("css-tree/lexer/error");
 // @ts-ignore
-const match_js_1 = require("css-tree/lib/lexer/match.js");
+const match_1 = require("css-tree/lexer/match");
 // @ts-ignore
-const prepare_tokens_js_1 = tslib_1.__importDefault(require("css-tree/lib/lexer/prepare-tokens.js"));
+const prepare_tokens_1 = tslib_1.__importDefault(require("css-tree/lexer/prepare-tokens"));
 const debug_1 = require("./debug");
 const defs_1 = require("./defs");
 const match_result_1 = require("./match-result");
@@ -74,8 +74,8 @@ function cssSyntaxMatch(value, type) {
         // 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);
+    const tokens = (0, prepare_tokens_1.default)(value, lexer.syntax);
+    const result = (0, match_1.matchAsTree)(tokens, matcher.match, lexer);
     if (caseSensitive) {
         if (result.tokens && Array.isArray(result.tokens)) {
             let reducer = 0;
@@ -99,7 +99,7 @@ function cssSyntaxMatch(value, type) {
         }
         return (0, match_result_1.matched)();
     }
-    const error = new error_js_1.SyntaxMatchError(result.reason, matcher.syntax, value, result);
+    const error = new error_1.SyntaxMatchError(result.reason, matcher.syntax, value, result);
     if (caseSensitive) {
         error.message = deMimicCases(error.message);
         error.syntax = deMimicCases(error.syntax);

package/lib/get-candidate.d.ts

@@ -1,6 +1,3 @@
 type NullableString = string | null | undefined;
-export declare function getCandidate(
-	value: NullableString,
-	...candidates: (NullableString | NullableString[])[]
-): string | undefined;
+export declare function getCandidate(value: NullableString, ...candidates: (NullableString | NullableString[])[]): string | undefined;
 export {};

package/lib/match-result.d.ts

@@ -1,22 +1,9 @@
-import type {
-	FormattedPrimitiveTypeCheck,
-	MatchedResult,
-	UnmatchedResult,
-	UnmatchedResultOptions,
-	UnmatchedResultReason,
-} from './types';
-export declare function matches(
-	checker: FormattedPrimitiveTypeCheck,
-	options?: UnmatchedResultOptions & {
-		ref?: string;
-		reason?: UnmatchedResultReason;
-	},
-): (value: string) => MatchedResult | UnmatchedResult;
+import type { FormattedPrimitiveTypeCheck, MatchedResult, UnmatchedResult, UnmatchedResultOptions, UnmatchedResultReason } from './types';
+export declare function matches(checker: FormattedPrimitiveTypeCheck, options?: UnmatchedResultOptions & {
+    ref?: string;
+    reason?: UnmatchedResultReason;
+}): (value: string) => MatchedResult | UnmatchedResult;
 export declare function matched(): MatchedResult;
-export declare function unmatched(
-	value: string,
-	reason?: UnmatchedResultReason,
-	options?: UnmatchedResultOptions & {
-		ref?: string;
-	},
-): UnmatchedResult;
+export declare function unmatched(value: string, reason?: UnmatchedResultReason, options?: UnmatchedResultOptions & {
+    ref?: string;
+}): UnmatchedResult;

package/lib/primitive/is-uint.d.ts

@@ -3,9 +3,6 @@
  *
  * @param value
  */
-export declare function isUint(
-	value: string,
-	options?: {
-		gt?: number;
-	},
-): boolean;
+export declare function isUint(value: string, options?: {
+    gt?: number;
+}): boolean;

package/lib/primitive/split-unit.d.ts

@@ -4,6 +4,6 @@
  * @returns
  */
 export declare function splitUnit(value: string): {
-	num: string;
-	unit: string;
+    num: string;
+    unit: string;
 };

package/lib/token/token-collection.d.ts

@@ -1,71 +1,62 @@
 import type { UnmatchedResult } from '..';
 import type { Expect, Result, List } from '../types';
 import { Token } from './token';
-type TokenCollectionOptions = Partial<
-	Omit<List, 'token'> & {
-		specificSeparator: string | string[];
-	}
->;
+type TokenCollectionOptions = Partial<Omit<List, 'token'> & {
+    specificSeparator: string | string[];
+}>;
 export type TokenEachCheck = (head: Token | null, tail: TokenCollection) => Result | void;
 export declare class TokenCollection extends Array<Token> {
-	static fromPatterns(
-		value: Token | string,
-		patterns: RegExp[],
-		typeOptions?: Omit<TokenCollectionOptions, 'specificSeparator'> & {
-			repeat?: boolean;
-		},
-	): TokenCollection;
-	static get [Symbol.species](): ArrayConstructor;
-	readonly allowEmpty: NonNullable<List['allowEmpty']>;
-	readonly caseInsensitive: NonNullable<List['caseInsensitive']>;
-	readonly disallowToSurroundBySpaces: NonNullable<List['disallowToSurroundBySpaces']>;
-	readonly number: List['number'];
-	readonly ordered: NonNullable<List['ordered']>;
-	readonly separator: NonNullable<List['separator']>;
-	readonly unique: NonNullable<List['unique']>;
-	constructor(value?: string, typeOptions?: TokenCollectionOptions);
-	constructor(value?: number);
-	get value(): string;
-	check(options?: {
-		expects?: Expect[];
-		ref?: string;
-		cache?: boolean;
-	}): import('..').MatchedResult | UnmatchedResult;
-	chunk(split: number): TokenCollection[];
-	compareTokens(callback: (prev: Token, current: Token) => Token | null | void): Token | null | undefined;
-	divide(position: number): readonly [TokenCollection, TokenCollection];
-	eachCheck(...callbacks: TokenEachCheck[]): Result;
-	filter(callback: (value: Token, index: number, array: Token[]) => boolean): TokenCollection;
-	getConsecutiveToken(tokenType: number): Token | null;
-	getDuplicated(): Token | null;
-	getIdentTokens(): TokenCollection;
-	/**
-	 *
-	 * @param value The token value or the token type or its list
-	 */
-	has(value: string | RegExp | number | (string | RegExp | number)[]): boolean;
-	headAndTail(): {
-		head: Token | null;
-		tail: TokenCollection;
-	};
-	/**
-	 *
-	 * @param value The token value or the token type or its list
-	 */
-	search(value: string | RegExp | number | (string | RegExp | number)[]): Token | null;
-	takeTurns(
-		tokenNumbers: ReadonlyArray<number>,
-		lastTokenNumber?: number,
-	): {
-		unexpectedLastToken: boolean;
-		expectedTokenNumber: number;
-		token: Token;
-	} | null;
-	toJSON(): {
-		type: number;
-		value: string;
-		offset: number;
-	}[];
-	private static _new;
+    static fromPatterns(value: Token | string, patterns: RegExp[], typeOptions?: Omit<TokenCollectionOptions, 'specificSeparator'> & {
+        repeat?: boolean;
+    }): TokenCollection;
+    static get [Symbol.species](): ArrayConstructor;
+    readonly allowEmpty: NonNullable<List['allowEmpty']>;
+    readonly caseInsensitive: NonNullable<List['caseInsensitive']>;
+    readonly disallowToSurroundBySpaces: NonNullable<List['disallowToSurroundBySpaces']>;
+    readonly number: List['number'];
+    readonly ordered: NonNullable<List['ordered']>;
+    readonly separator: NonNullable<List['separator']>;
+    readonly unique: NonNullable<List['unique']>;
+    constructor(value?: string, typeOptions?: TokenCollectionOptions);
+    constructor(value?: number);
+    get value(): string;
+    check(options?: {
+        expects?: Expect[];
+        ref?: string;
+        cache?: boolean;
+    }): import("..").MatchedResult | UnmatchedResult;
+    chunk(split: number): TokenCollection[];
+    compareTokens(callback: (prev: Token, current: Token) => Token | null | void): Token | null | undefined;
+    divide(position: number): readonly [TokenCollection, TokenCollection];
+    eachCheck(...callbacks: TokenEachCheck[]): Result;
+    filter(callback: (value: Token, index: number, array: Token[]) => boolean): TokenCollection;
+    getConsecutiveToken(tokenType: number): Token | null;
+    getDuplicated(): Token | null;
+    getIdentTokens(): TokenCollection;
+    /**
+     *
+     * @param value The token value or the token type or its list
+     */
+    has(value: string | RegExp | number | (string | RegExp | number)[]): boolean;
+    headAndTail(): {
+        head: Token | null;
+        tail: TokenCollection;
+    };
+    /**
+     *
+     * @param value The token value or the token type or its list
+     */
+    search(value: string | RegExp | number | (string | RegExp | number)[]): Token | null;
+    takeTurns(tokenNumbers: ReadonlyArray<number>, lastTokenNumber?: number): {
+        unexpectedLastToken: boolean;
+        expectedTokenNumber: number;
+        token: Token;
+    } | null;
+    toJSON(): {
+        type: number;
+        value: string;
+        offset: number;
+    }[];
+    private static _new;
 }
 export {};

package/lib/token/token.d.ts

@@ -1,60 +1,55 @@
 import type { UnmatchedResult, UnmatchedResultOptions, UnmatchedResultReason } from '../types';
 export declare class Token {
-	#private;
-	/**
-	 * @see https://github.com/csstree/csstree/blob/master/lib/tokenizer/types.js
-	 */
-	static readonly Comma = 18;
-	static readonly Ident = 1;
-	static readonly WhiteSpace = 13;
-	/**
-	 * ASCII whitespace is
-	 * - U+0009 TAB
-	 * - U+000A LF
-	 * - U+000C FF
-	 * - U+000D CR
-	 * - U+0020 SPACE.
-	 *
-	 * @see https://infra.spec.whatwg.org/#ascii-whitespace
-	 */
-	static readonly whitespace: ReadonlyArray<string>;
-	static getCol(value: string, offset: number): number;
-	static getLine(value: string, offset: number): number;
-	static getType(value: string, separators?: string[]): 1 | 13 | 18;
-	static shiftLocation(
-		token: Token,
-		offset: number,
-	): {
-		offset: number;
-		line: number;
-		column: number;
-	};
-	readonly offset: number;
-	readonly type: number;
-	readonly value: string;
-	constructor(value: string, offset: number, originalValue: string, separators?: string[]);
-	get length(): number;
-	get origin(): string;
-	/**
-	 *
-	 * @param value The token value or the token type or its list
-	 */
-	includes(value: string | RegExp | number | (string | RegExp | number)[], caseInsensitive?: boolean): boolean;
-	/**
-	 *
-	 * @param value The token value or the token type or its list
-	 */
-	match(value: string | RegExp | number | (string | RegExp | number)[], caseInsensitive?: boolean): boolean;
-	toJSON(): {
-		type: number;
-		value: string;
-		offset: number;
-	};
-	toNumber(): number;
-	unmatched(
-		options?: UnmatchedResultOptions & {
-			ref?: string;
-			reason?: UnmatchedResultReason;
-		},
-	): UnmatchedResult;
+    #private;
+    /**
+     * @see https://github.com/csstree/csstree/blob/master/lib/tokenizer/types.js
+     */
+    static readonly Comma = 18;
+    static readonly Ident = 1;
+    static readonly WhiteSpace = 13;
+    /**
+     * ASCII whitespace is
+     * - U+0009 TAB
+     * - U+000A LF
+     * - U+000C FF
+     * - U+000D CR
+     * - U+0020 SPACE.
+     *
+     * @see https://infra.spec.whatwg.org/#ascii-whitespace
+     */
+    static readonly whitespace: ReadonlyArray<string>;
+    static getCol(value: string, offset: number): number;
+    static getLine(value: string, offset: number): number;
+    static getType(value: string, separators?: string[]): 1 | 13 | 18;
+    static shiftLocation(token: Token, offset: number): {
+        offset: number;
+        line: number;
+        column: number;
+    };
+    readonly offset: number;
+    readonly type: number;
+    readonly value: string;
+    constructor(value: string, offset: number, originalValue: string, separators?: string[]);
+    get length(): number;
+    get origin(): string;
+    /**
+     *
+     * @param value The token value or the token type or its list
+     */
+    includes(value: string | RegExp | number | (string | RegExp | number)[], caseInsensitive?: boolean): boolean;
+    /**
+     *
+     * @param value The token value or the token type or its list
+     */
+    match(value: string | RegExp | number | (string | RegExp | number)[], caseInsensitive?: boolean): boolean;
+    toJSON(): {
+        type: number;
+        value: string;
+        offset: number;
+    };
+    toNumber(): number;
+    unmatched(options?: UnmatchedResultOptions & {
+        ref?: string;
+        reason?: UnmatchedResultReason;
+    }): UnmatchedResult;
 }

package/lib/types.d.ts

@@ -2,101 +2,77 @@ import type { cssSyntaxMatch } from './css-syntax';
 export type { Type, List, Enum, CssSyntax, KeywordDefinedType, Number } from './types.schema';
 export type Result = UnmatchedResult | MatchedResult;
 export type UnmatchedResult = {
-	matched: false;
-	ref: string | null;
-	raw: string;
-	length: number;
-	offset: number;
-	line: number;
-	column: number;
-	reason: UnmatchedResultReason;
-	passCount?: number;
+    matched: false;
+    ref: string | null;
+    raw: string;
+    length: number;
+    offset: number;
+    line: number;
+    column: number;
+    reason: UnmatchedResultReason;
+    passCount?: number;
 } & UnmatchedResultOptions;
 export type UnmatchedResultOptions = {
-	partName?: string;
-	expects?: Expect[];
-	extra?: Expect;
-	candidate?: string;
+    partName?: string;
+    expects?: Expect[];
+    extra?: Expect;
+    candidate?: string;
+};
+export type UnmatchedResultReason = 'syntax-error' | 'typo' | 'missing-token' | 'missing-comma' | 'unexpected-token' | 'unexpected-space' | 'unexpected-newline' | 'unexpected-comma' | 'empty-token' | 'out-of-range' | 'doesnt-exist-in-enum' | 'duplicated' | 'illegal-combination' | 'illegal-order' | 'extra-token' | 'must-be-percent-encoded' | 'must-be-serialized' | {
+    type: 'out-of-range';
+    gt?: number;
+    gte?: number;
+    lt?: number;
+    lte?: number;
+} | {
+    type: 'out-of-range-length-char';
+    gte: number;
+    lte?: number;
+} | {
+    type: 'out-of-range-length-digit';
+    gte: number;
+    lte?: number;
 };
-export type UnmatchedResultReason =
-	| 'syntax-error'
-	| 'typo'
-	| 'missing-token'
-	| 'missing-comma'
-	| 'unexpected-token'
-	| 'unexpected-space'
-	| 'unexpected-newline'
-	| 'unexpected-comma'
-	| 'empty-token'
-	| 'out-of-range'
-	| 'doesnt-exist-in-enum'
-	| 'duplicated'
-	| 'illegal-combination'
-	| 'illegal-order'
-	| 'extra-token'
-	| 'must-be-percent-encoded'
-	| 'must-be-serialized'
-	| {
-			type: 'out-of-range';
-			gt?: number;
-			gte?: number;
-			lt?: number;
-			lte?: number;
-	  }
-	| {
-			type: 'out-of-range-length-char';
-			gte: number;
-			lte?: number;
-	  }
-	| {
-			type: 'out-of-range-length-digit';
-			gte: number;
-			lte?: number;
-	  };
 export type MatchedResult = {
-	matched: true;
+    matched: true;
 };
 export type Expect = {
-	type: 'const' | 'format' | 'syntax' | 'regexp' | 'common';
-	value: string;
+    type: 'const' | 'format' | 'syntax' | 'regexp' | 'common';
+    value: string;
 };
 export type FormattedPrimitiveTypeCheck = (value: string) => boolean;
 export type FormattedPrimitiveTypeCreator<O = never> = (options?: O) => FormattedPrimitiveTypeCheck;
 export type Defs = Record<string, CustomCssSyntax | CustomSyntax>;
 export type CustomSyntax = {
-	ref: string;
-	expects?: Expect[];
-	is: CustomSyntaxCheck;
+    ref: string;
+    expects?: Expect[];
+    is: CustomSyntaxCheck;
 };
 export type CustomSyntaxCheck = (value: string) => Result;
 export type CustomSyntaxChecker<O = {}> = (options?: O) => CustomSyntaxCheck;
 export type CustomCssSyntax = {
-	ref: string;
-	caseSensitive?: boolean;
-	expects?: Expect[];
-	syntax: {
-		apply: `<${string}>`;
-		def: Record<string, string | CssSyntaxTokenizer>;
-		/**
-		 * @deprecated
-		 */
-		ebnf?: Record<string, string | string[]>;
-		/**
-		 * @deprecated
-		 */
-		properties?: Record<string, string>;
-	};
+    ref: string;
+    caseSensitive?: boolean;
+    expects?: Expect[];
+    syntax: {
+        apply: `<${string}>`;
+        def: Record<string, string | CssSyntaxTokenizer>;
+        /**
+         * @deprecated
+         */
+        ebnf?: Record<string, string | string[]>;
+        /**
+         * @deprecated
+         */
+        properties?: Record<string, string>;
+    };
 };
 export type CSSSyntaxToken = {
-	type: number;
-	value: string;
-	index: number;
-	balance: number;
-	node?: any;
+    type: number;
+    value: string;
+    index: number;
+    balance: number;
+    node?: any;
 };
-export type CssSyntaxTokenizer = (
-	token: CSSSyntaxToken | null,
-	getNextToken: GetNextToken,
-	match: typeof cssSyntaxMatch,
-) => number;
+export type CssSyntaxTokenizer = (token: CSSSyntaxToken | null, getNextToken: GetNextToken, match: typeof cssSyntaxMatch) => number;
 export type GetNextToken = (length: number) => CSSSyntaxToken | null;