@markuplint/types 1.0.0-rc.1 → 2.0.0

package/README.md

@@ -6,8 +6,6 @@
 
 ## Install
 
-Prerequisites: [Node.js](https://nodejs.org) (Version 12.4.0 or later)
-
 ```sh
 $ npm install @markuplint/types
 
@@ -102,16 +100,3 @@ 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.
-
-## Contributing
-
-```
-$ git clone git@github.com:markuplint/markuplint.git -b main
-$ yarn
-$ yarn build
-$ yarn test
-```
-
----
-
-Copyright &copy; 2021 markuplint. Under the MIT License.

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

@@ -1,2 +1,5 @@
 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/get-candicate.d.ts

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

package/lib/match-result.d.ts

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

package/lib/token/token.d.ts

@@ -1,55 +1,60 @@
 import type { UnmatchedResult, UnmatchedResultOptions, UnmatchedResultReason } from '../types';
 export declare class Token {
-    #private;
-    static getType(value: string, separators?: string[]): 1 | 13 | 18;
-    static getLine(value: string, offset: number): number;
-    static getCol(value: string, offset: number): number;
-    static shiftLocation(token: Token, offset: number): {
-        offset: number;
-        line: number;
-        column: number;
-    };
-    /**
-     * 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>;
-    /**
-     * @see https://github.com/csstree/csstree/blob/master/lib/tokenizer/types.js
-     */
-    static readonly Ident = 1;
-    static readonly WhiteSpace = 13;
-    static readonly Comma = 18;
-    readonly type: number;
-    readonly value: string;
-    readonly offset: number;
-    constructor(value: string, offset: number, originalValue: string, separators?: string[]);
-    get length(): number;
-    get origin(): string;
-    unmatched(options?: UnmatchedResultOptions & {
-        ref?: string;
-        reason?: UnmatchedResultReason;
-    }): UnmatchedResult;
-    /**
-     *
-     * @param value The token value or the token type or its list
-     */
-    match(value: string | RegExp | number | (string | RegExp | number)[], caseInsensitive?: boolean): boolean;
-    /**
-     *
-     * @param value The token value or the token type or its list
-     */
-    includes(value: string | RegExp | number | (string | RegExp | number)[], caseInsensitive?: boolean): boolean;
-    toNumber(): number;
-    toJSON(): {
-        type: number;
-        value: string;
-        offset: number;
-    };
+	#private;
+	static getType(value: string, separators?: string[]): 1 | 13 | 18;
+	static getLine(value: string, offset: number): number;
+	static getCol(value: string, offset: number): number;
+	static shiftLocation(
+		token: Token,
+		offset: number,
+	): {
+		offset: number;
+		line: number;
+		column: number;
+	};
+	/**
+	 * 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>;
+	/**
+	 * @see https://github.com/csstree/csstree/blob/master/lib/tokenizer/types.js
+	 */
+	static readonly Ident = 1;
+	static readonly WhiteSpace = 13;
+	static readonly Comma = 18;
+	readonly type: number;
+	readonly value: string;
+	readonly offset: number;
+	constructor(value: string, offset: number, originalValue: string, separators?: string[]);
+	get length(): number;
+	get origin(): string;
+	unmatched(
+		options?: UnmatchedResultOptions & {
+			ref?: string;
+			reason?: UnmatchedResultReason;
+		},
+	): UnmatchedResult;
+	/**
+	 *
+	 * @param value The token value or the token type or its list
+	 */
+	match(value: string | RegExp | number | (string | RegExp | number)[], caseInsensitive?: boolean): boolean;
+	/**
+	 *
+	 * @param value The token value or the token type or its list
+	 */
+	includes(value: string | RegExp | number | (string | RegExp | number)[], caseInsensitive?: boolean): boolean;
+	toNumber(): number;
+	toJSON(): {
+		type: number;
+		value: string;
+		offset: number;
+	};
 }

package/lib/types.d.ts

@@ -2,77 +2,101 @@ import type { cssSyntaxMatch } from './css-syntax';
 export type { Type, List, Enum, CssSyntax, KeywordDefinedType, Number } from './types.schema';
 export declare type Result = UnmatchedResult | MatchedResult;
 export declare 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 declare type UnmatchedResultOptions = {
-    partName?: string;
-    expects?: Expect[];
-    extra?: Expect;
-    candicate?: string;
-};
-export declare 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;
+	partName?: string;
+	expects?: Expect[];
+	extra?: Expect;
+	candicate?: string;
 };
+export declare 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 declare type MatchedResult = {
-    matched: true;
+	matched: true;
 };
 export declare type Expect = {
-    type: 'const' | 'format' | 'syntax' | 'regxp' | 'common';
-    value: string;
+	type: 'const' | 'format' | 'syntax' | 'regxp' | 'common';
+	value: string;
 };
 export declare type FormattedPrimitiveTypeCheck = (value: string) => boolean;
 export declare type FormattedPrimitiveTypeCreator<O = never> = (options?: O) => FormattedPrimitiveTypeCheck;
 export declare type Defs = Record<string, CustomCssSyntax | CustomSyntax>;
 export declare type CustomSyntax = {
-    ref: string;
-    expects?: Expect[];
-    is: CustomSyntaxCheck;
+	ref: string;
+	expects?: Expect[];
+	is: CustomSyntaxCheck;
 };
 export declare type CustomSyntaxCheck = (value: string) => Result;
 export declare type CustomSyntaxChecker<O = {}> = (options?: O) => CustomSyntaxCheck;
 export declare 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 declare type CSSSyntaxToken = {
-    type: number;
-    value: string;
-    index: number;
-    balance: number;
-    node?: any;
+	type: number;
+	value: string;
+	index: number;
+	balance: number;
+	node?: any;
 };
-export declare type CssSyntaxTokenizer = (token: CSSSyntaxToken | null, getNextToken: GetNextToken, match: typeof cssSyntaxMatch) => number;
+export declare type CssSyntaxTokenizer = (
+	token: CSSSyntaxToken | null,
+	getNextToken: GetNextToken,
+	match: typeof cssSyntaxMatch,
+) => number;
 export declare type GetNextToken = (length: number) => CSSSyntaxToken | null;