@markuplint/types 3.0.0-rc.4 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (73) hide show
  1. package/lib/check-multi-types.d.ts +1 -4
  2. package/lib/get-candidate.d.ts +1 -4
  3. package/lib/match-result.d.ts +8 -21
  4. package/lib/primitive/is-uint.d.ts +3 -6
  5. package/lib/primitive/split-unit.d.ts +2 -2
  6. package/lib/token/token-collection.d.ts +55 -64
  7. package/lib/token/token.d.ts +52 -57
  8. package/lib/types.d.ts +55 -79
  9. package/lib/types.schema.d.ts +31 -1033
  10. package/lib/whatwg/check-datetime/datetime-tokens.d.ts +1 -21
  11. package/lib/whatwg/check-datetime/time-zone-offset-string.d.ts +1 -1
  12. package/lib/whatwg/check-mime-type.d.ts +4 -4
  13. package/package.json +2 -2
  14. package/gen/specific-schema.json +0 -98
  15. package/gen/types.ts +0 -66
  16. package/src/check-multi-types.ts +0 -35
  17. package/src/check.spec.ts +0 -83
  18. package/src/check.ts +0 -48
  19. package/src/css-syntax.spec.ts +0 -167
  20. package/src/css-syntax.ts +0 -188
  21. package/src/debug.ts +0 -3
  22. package/src/defs.ts +0 -811
  23. package/src/enum.ts +0 -25
  24. package/src/get-candidate.ts +0 -24
  25. package/src/index.ts +0 -3
  26. package/src/keyword-type.ts +0 -64
  27. package/src/list.spec.ts +0 -133
  28. package/src/list.ts +0 -34
  29. package/src/match-result.ts +0 -49
  30. package/src/number.ts +0 -46
  31. package/src/primitive/index.spec.ts +0 -65
  32. package/src/primitive/index.ts +0 -7
  33. package/src/primitive/is-float.ts +0 -8
  34. package/src/primitive/is-int.ts +0 -8
  35. package/src/primitive/is-non-zero-uint.ts +0 -8
  36. package/src/primitive/is-quantity.ts +0 -38
  37. package/src/primitive/is-uint.ts +0 -15
  38. package/src/primitive/range.ts +0 -14
  39. package/src/primitive/split-unit.ts +0 -20
  40. package/src/rfc/is-bcp-47.spec.ts +0 -23
  41. package/src/rfc/is-bcp-47.ts +0 -13
  42. package/src/token/index.ts +0 -2
  43. package/src/token/token-collection.spec.ts +0 -147
  44. package/src/token/token-collection.ts +0 -444
  45. package/src/token/token.ts +0 -144
  46. package/src/types.schema.ts +0 -1062
  47. package/src/types.ts +0 -118
  48. package/src/w3c/check-serialized-permissions-policy.spec.ts +0 -38
  49. package/src/w3c/check-serialized-permissions-policy.ts +0 -303
  50. package/src/whatwg/check-autocomplete.spec.ts +0 -387
  51. package/src/whatwg/check-autocomplete.ts +0 -380
  52. package/src/whatwg/check-datetime/date-string.ts +0 -44
  53. package/src/whatwg/check-datetime/datetime-tokens.ts +0 -600
  54. package/src/whatwg/check-datetime/duration-string.ts +0 -399
  55. package/src/whatwg/check-datetime/global-date-and-time-string.ts +0 -96
  56. package/src/whatwg/check-datetime/index.spec.ts +0 -333
  57. package/src/whatwg/check-datetime/index.ts +0 -36
  58. package/src/whatwg/check-datetime/local-date-and-time-string.ts +0 -163
  59. package/src/whatwg/check-datetime/month-string.ts +0 -31
  60. package/src/whatwg/check-datetime/time-string.ts +0 -49
  61. package/src/whatwg/check-datetime/time-zone-offset-string.ts +0 -93
  62. package/src/whatwg/check-datetime/week-string.ts +0 -41
  63. package/src/whatwg/check-datetime/year-string.ts +0 -26
  64. package/src/whatwg/check-datetime/yearless-date-string.ts +0 -38
  65. package/src/whatwg/check-mime-type.spec.ts +0 -59
  66. package/src/whatwg/check-mime-type.ts +0 -46
  67. package/src/whatwg/is-abs-url.spec.ts +0 -8
  68. package/src/whatwg/is-abs-url.ts +0 -31
  69. package/src/whatwg/is-browser-context-name.ts +0 -16
  70. package/src/whatwg/is-custom-element-name.ts +0 -76
  71. package/src/whatwg/is-itemprop-name.ts +0 -17
  72. package/tsconfig.test.json +0 -3
  73. package/tsconfig.tsbuildinfo +0 -1
@@ -1,5 +1,2 @@
1
1
  import type { CustomSyntaxCheck, UnmatchedResult } from './types';
2
- export declare function checkMultiTypes(
3
- value: string,
4
- checks: CustomSyntaxCheck[],
5
- ): import('./types').MatchedResult | UnmatchedResult;
2
+ export declare function checkMultiTypes(value: string, checks: CustomSyntaxCheck[]): import("./types").MatchedResult | UnmatchedResult;
@@ -1,6 +1,3 @@
1
1
  type NullableString = string | null | undefined;
2
- export declare function getCandidate(
3
- value: NullableString,
4
- ...candidates: (NullableString | NullableString[])[]
5
- ): string | undefined;
2
+ export declare function getCandidate(value: NullableString, ...candidates: (NullableString | NullableString[])[]): string | undefined;
6
3
  export {};
@@ -1,22 +1,9 @@
1
- import type {
2
- FormattedPrimitiveTypeCheck,
3
- MatchedResult,
4
- UnmatchedResult,
5
- UnmatchedResultOptions,
6
- UnmatchedResultReason,
7
- } from './types';
8
- export declare function matches(
9
- checker: FormattedPrimitiveTypeCheck,
10
- options?: UnmatchedResultOptions & {
11
- ref?: string;
12
- reason?: UnmatchedResultReason;
13
- },
14
- ): (value: string) => MatchedResult | UnmatchedResult;
1
+ import type { FormattedPrimitiveTypeCheck, MatchedResult, UnmatchedResult, UnmatchedResultOptions, UnmatchedResultReason } from './types';
2
+ export declare function matches(checker: FormattedPrimitiveTypeCheck, options?: UnmatchedResultOptions & {
3
+ ref?: string;
4
+ reason?: UnmatchedResultReason;
5
+ }): (value: string) => MatchedResult | UnmatchedResult;
15
6
  export declare function matched(): MatchedResult;
16
- export declare function unmatched(
17
- value: string,
18
- reason?: UnmatchedResultReason,
19
- options?: UnmatchedResultOptions & {
20
- ref?: string;
21
- },
22
- ): UnmatchedResult;
7
+ export declare function unmatched(value: string, reason?: UnmatchedResultReason, options?: UnmatchedResultOptions & {
8
+ ref?: string;
9
+ }): UnmatchedResult;
@@ -3,9 +3,6 @@
3
3
  *
4
4
  * @param value
5
5
  */
6
- export declare function isUint(
7
- value: string,
8
- options?: {
9
- gt?: number;
10
- },
11
- ): boolean;
6
+ export declare function isUint(value: string, options?: {
7
+ gt?: number;
8
+ }): boolean;
@@ -4,6 +4,6 @@
4
4
  * @returns
5
5
  */
6
6
  export declare function splitUnit(value: string): {
7
- num: string;
8
- unit: string;
7
+ num: string;
8
+ unit: string;
9
9
  };
@@ -1,71 +1,62 @@
1
1
  import type { UnmatchedResult } from '..';
2
2
  import type { Expect, Result, List } from '../types';
3
3
  import { Token } from './token';
4
- type TokenCollectionOptions = Partial<
5
- Omit<List, 'token'> & {
6
- specificSeparator: string | string[];
7
- }
8
- >;
4
+ type TokenCollectionOptions = Partial<Omit<List, 'token'> & {
5
+ specificSeparator: string | string[];
6
+ }>;
9
7
  export type TokenEachCheck = (head: Token | null, tail: TokenCollection) => Result | void;
10
8
  export declare class TokenCollection extends Array<Token> {
11
- static fromPatterns(
12
- value: Token | string,
13
- patterns: RegExp[],
14
- typeOptions?: Omit<TokenCollectionOptions, 'specificSeparator'> & {
15
- repeat?: boolean;
16
- },
17
- ): TokenCollection;
18
- static get [Symbol.species](): ArrayConstructor;
19
- readonly allowEmpty: NonNullable<List['allowEmpty']>;
20
- readonly caseInsensitive: NonNullable<List['caseInsensitive']>;
21
- readonly disallowToSurroundBySpaces: NonNullable<List['disallowToSurroundBySpaces']>;
22
- readonly number: List['number'];
23
- readonly ordered: NonNullable<List['ordered']>;
24
- readonly separator: NonNullable<List['separator']>;
25
- readonly unique: NonNullable<List['unique']>;
26
- constructor(value?: string, typeOptions?: TokenCollectionOptions);
27
- constructor(value?: number);
28
- get value(): string;
29
- check(options?: {
30
- expects?: Expect[];
31
- ref?: string;
32
- cache?: boolean;
33
- }): import('..').MatchedResult | UnmatchedResult;
34
- chunk(split: number): TokenCollection[];
35
- compareTokens(callback: (prev: Token, current: Token) => Token | null | void): Token | null | undefined;
36
- divide(position: number): readonly [TokenCollection, TokenCollection];
37
- eachCheck(...callbacks: TokenEachCheck[]): Result;
38
- filter(callback: (value: Token, index: number, array: Token[]) => boolean): TokenCollection;
39
- getConsecutiveToken(tokenType: number): Token | null;
40
- getDuplicated(): Token | null;
41
- getIdentTokens(): TokenCollection;
42
- /**
43
- *
44
- * @param value The token value or the token type or its list
45
- */
46
- has(value: string | RegExp | number | (string | RegExp | number)[]): boolean;
47
- headAndTail(): {
48
- head: Token | null;
49
- tail: TokenCollection;
50
- };
51
- /**
52
- *
53
- * @param value The token value or the token type or its list
54
- */
55
- search(value: string | RegExp | number | (string | RegExp | number)[]): Token | null;
56
- takeTurns(
57
- tokenNumbers: ReadonlyArray<number>,
58
- lastTokenNumber?: number,
59
- ): {
60
- unexpectedLastToken: boolean;
61
- expectedTokenNumber: number;
62
- token: Token;
63
- } | null;
64
- toJSON(): {
65
- type: number;
66
- value: string;
67
- offset: number;
68
- }[];
69
- private static _new;
9
+ static fromPatterns(value: Token | string, patterns: RegExp[], typeOptions?: Omit<TokenCollectionOptions, 'specificSeparator'> & {
10
+ repeat?: boolean;
11
+ }): TokenCollection;
12
+ static get [Symbol.species](): ArrayConstructor;
13
+ readonly allowEmpty: NonNullable<List['allowEmpty']>;
14
+ readonly caseInsensitive: NonNullable<List['caseInsensitive']>;
15
+ readonly disallowToSurroundBySpaces: NonNullable<List['disallowToSurroundBySpaces']>;
16
+ readonly number: List['number'];
17
+ readonly ordered: NonNullable<List['ordered']>;
18
+ readonly separator: NonNullable<List['separator']>;
19
+ readonly unique: NonNullable<List['unique']>;
20
+ constructor(value?: string, typeOptions?: TokenCollectionOptions);
21
+ constructor(value?: number);
22
+ get value(): string;
23
+ check(options?: {
24
+ expects?: Expect[];
25
+ ref?: string;
26
+ cache?: boolean;
27
+ }): import("..").MatchedResult | UnmatchedResult;
28
+ chunk(split: number): TokenCollection[];
29
+ compareTokens(callback: (prev: Token, current: Token) => Token | null | void): Token | null | undefined;
30
+ divide(position: number): readonly [TokenCollection, TokenCollection];
31
+ eachCheck(...callbacks: TokenEachCheck[]): Result;
32
+ filter(callback: (value: Token, index: number, array: Token[]) => boolean): TokenCollection;
33
+ getConsecutiveToken(tokenType: number): Token | null;
34
+ getDuplicated(): Token | null;
35
+ getIdentTokens(): TokenCollection;
36
+ /**
37
+ *
38
+ * @param value The token value or the token type or its list
39
+ */
40
+ has(value: string | RegExp | number | (string | RegExp | number)[]): boolean;
41
+ headAndTail(): {
42
+ head: Token | null;
43
+ tail: TokenCollection;
44
+ };
45
+ /**
46
+ *
47
+ * @param value The token value or the token type or its list
48
+ */
49
+ search(value: string | RegExp | number | (string | RegExp | number)[]): Token | null;
50
+ takeTurns(tokenNumbers: ReadonlyArray<number>, lastTokenNumber?: number): {
51
+ unexpectedLastToken: boolean;
52
+ expectedTokenNumber: number;
53
+ token: Token;
54
+ } | null;
55
+ toJSON(): {
56
+ type: number;
57
+ value: string;
58
+ offset: number;
59
+ }[];
60
+ private static _new;
70
61
  }
71
62
  export {};
@@ -1,60 +1,55 @@
1
1
  import type { UnmatchedResult, UnmatchedResultOptions, UnmatchedResultReason } from '../types';
2
2
  export declare class Token {
3
- #private;
4
- /**
5
- * @see https://github.com/csstree/csstree/blob/master/lib/tokenizer/types.js
6
- */
7
- static readonly Comma = 18;
8
- static readonly Ident = 1;
9
- static readonly WhiteSpace = 13;
10
- /**
11
- * ASCII whitespace is
12
- * - U+0009 TAB
13
- * - U+000A LF
14
- * - U+000C FF
15
- * - U+000D CR
16
- * - U+0020 SPACE.
17
- *
18
- * @see https://infra.spec.whatwg.org/#ascii-whitespace
19
- */
20
- static readonly whitespace: ReadonlyArray<string>;
21
- static getCol(value: string, offset: number): number;
22
- static getLine(value: string, offset: number): number;
23
- static getType(value: string, separators?: string[]): 1 | 13 | 18;
24
- static shiftLocation(
25
- token: Token,
26
- offset: number,
27
- ): {
28
- offset: number;
29
- line: number;
30
- column: number;
31
- };
32
- readonly offset: number;
33
- readonly type: number;
34
- readonly value: string;
35
- constructor(value: string, offset: number, originalValue: string, separators?: string[]);
36
- get length(): number;
37
- get origin(): string;
38
- /**
39
- *
40
- * @param value The token value or the token type or its list
41
- */
42
- includes(value: string | RegExp | number | (string | RegExp | number)[], caseInsensitive?: boolean): boolean;
43
- /**
44
- *
45
- * @param value The token value or the token type or its list
46
- */
47
- match(value: string | RegExp | number | (string | RegExp | number)[], caseInsensitive?: boolean): boolean;
48
- toJSON(): {
49
- type: number;
50
- value: string;
51
- offset: number;
52
- };
53
- toNumber(): number;
54
- unmatched(
55
- options?: UnmatchedResultOptions & {
56
- ref?: string;
57
- reason?: UnmatchedResultReason;
58
- },
59
- ): UnmatchedResult;
3
+ #private;
4
+ /**
5
+ * @see https://github.com/csstree/csstree/blob/master/lib/tokenizer/types.js
6
+ */
7
+ static readonly Comma = 18;
8
+ static readonly Ident = 1;
9
+ static readonly WhiteSpace = 13;
10
+ /**
11
+ * ASCII whitespace is
12
+ * - U+0009 TAB
13
+ * - U+000A LF
14
+ * - U+000C FF
15
+ * - U+000D CR
16
+ * - U+0020 SPACE.
17
+ *
18
+ * @see https://infra.spec.whatwg.org/#ascii-whitespace
19
+ */
20
+ static readonly whitespace: ReadonlyArray<string>;
21
+ static getCol(value: string, offset: number): number;
22
+ static getLine(value: string, offset: number): number;
23
+ static getType(value: string, separators?: string[]): 1 | 13 | 18;
24
+ static shiftLocation(token: Token, offset: number): {
25
+ offset: number;
26
+ line: number;
27
+ column: number;
28
+ };
29
+ readonly offset: number;
30
+ readonly type: number;
31
+ readonly value: string;
32
+ constructor(value: string, offset: number, originalValue: string, separators?: string[]);
33
+ get length(): number;
34
+ get origin(): string;
35
+ /**
36
+ *
37
+ * @param value The token value or the token type or its list
38
+ */
39
+ includes(value: string | RegExp | number | (string | RegExp | number)[], caseInsensitive?: boolean): boolean;
40
+ /**
41
+ *
42
+ * @param value The token value or the token type or its list
43
+ */
44
+ match(value: string | RegExp | number | (string | RegExp | number)[], caseInsensitive?: boolean): boolean;
45
+ toJSON(): {
46
+ type: number;
47
+ value: string;
48
+ offset: number;
49
+ };
50
+ toNumber(): number;
51
+ unmatched(options?: UnmatchedResultOptions & {
52
+ ref?: string;
53
+ reason?: UnmatchedResultReason;
54
+ }): UnmatchedResult;
60
55
  }
package/lib/types.d.ts CHANGED
@@ -2,101 +2,77 @@ import type { cssSyntaxMatch } from './css-syntax';
2
2
  export type { Type, List, Enum, CssSyntax, KeywordDefinedType, Number } from './types.schema';
3
3
  export type Result = UnmatchedResult | MatchedResult;
4
4
  export type UnmatchedResult = {
5
- matched: false;
6
- ref: string | null;
7
- raw: string;
8
- length: number;
9
- offset: number;
10
- line: number;
11
- column: number;
12
- reason: UnmatchedResultReason;
13
- passCount?: number;
5
+ matched: false;
6
+ ref: string | null;
7
+ raw: string;
8
+ length: number;
9
+ offset: number;
10
+ line: number;
11
+ column: number;
12
+ reason: UnmatchedResultReason;
13
+ passCount?: number;
14
14
  } & UnmatchedResultOptions;
15
15
  export type UnmatchedResultOptions = {
16
- partName?: string;
17
- expects?: Expect[];
18
- extra?: Expect;
19
- candidate?: string;
16
+ partName?: string;
17
+ expects?: Expect[];
18
+ extra?: Expect;
19
+ candidate?: string;
20
+ };
21
+ 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' | {
22
+ type: 'out-of-range';
23
+ gt?: number;
24
+ gte?: number;
25
+ lt?: number;
26
+ lte?: number;
27
+ } | {
28
+ type: 'out-of-range-length-char';
29
+ gte: number;
30
+ lte?: number;
31
+ } | {
32
+ type: 'out-of-range-length-digit';
33
+ gte: number;
34
+ lte?: number;
20
35
  };
21
- export type UnmatchedResultReason =
22
- | 'syntax-error'
23
- | 'typo'
24
- | 'missing-token'
25
- | 'missing-comma'
26
- | 'unexpected-token'
27
- | 'unexpected-space'
28
- | 'unexpected-newline'
29
- | 'unexpected-comma'
30
- | 'empty-token'
31
- | 'out-of-range'
32
- | 'doesnt-exist-in-enum'
33
- | 'duplicated'
34
- | 'illegal-combination'
35
- | 'illegal-order'
36
- | 'extra-token'
37
- | 'must-be-percent-encoded'
38
- | 'must-be-serialized'
39
- | {
40
- type: 'out-of-range';
41
- gt?: number;
42
- gte?: number;
43
- lt?: number;
44
- lte?: number;
45
- }
46
- | {
47
- type: 'out-of-range-length-char';
48
- gte: number;
49
- lte?: number;
50
- }
51
- | {
52
- type: 'out-of-range-length-digit';
53
- gte: number;
54
- lte?: number;
55
- };
56
36
  export type MatchedResult = {
57
- matched: true;
37
+ matched: true;
58
38
  };
59
39
  export type Expect = {
60
- type: 'const' | 'format' | 'syntax' | 'regexp' | 'common';
61
- value: string;
40
+ type: 'const' | 'format' | 'syntax' | 'regexp' | 'common';
41
+ value: string;
62
42
  };
63
43
  export type FormattedPrimitiveTypeCheck = (value: string) => boolean;
64
44
  export type FormattedPrimitiveTypeCreator<O = never> = (options?: O) => FormattedPrimitiveTypeCheck;
65
45
  export type Defs = Record<string, CustomCssSyntax | CustomSyntax>;
66
46
  export type CustomSyntax = {
67
- ref: string;
68
- expects?: Expect[];
69
- is: CustomSyntaxCheck;
47
+ ref: string;
48
+ expects?: Expect[];
49
+ is: CustomSyntaxCheck;
70
50
  };
71
51
  export type CustomSyntaxCheck = (value: string) => Result;
72
52
  export type CustomSyntaxChecker<O = {}> = (options?: O) => CustomSyntaxCheck;
73
53
  export type CustomCssSyntax = {
74
- ref: string;
75
- caseSensitive?: boolean;
76
- expects?: Expect[];
77
- syntax: {
78
- apply: `<${string}>`;
79
- def: Record<string, string | CssSyntaxTokenizer>;
80
- /**
81
- * @deprecated
82
- */
83
- ebnf?: Record<string, string | string[]>;
84
- /**
85
- * @deprecated
86
- */
87
- properties?: Record<string, string>;
88
- };
54
+ ref: string;
55
+ caseSensitive?: boolean;
56
+ expects?: Expect[];
57
+ syntax: {
58
+ apply: `<${string}>`;
59
+ def: Record<string, string | CssSyntaxTokenizer>;
60
+ /**
61
+ * @deprecated
62
+ */
63
+ ebnf?: Record<string, string | string[]>;
64
+ /**
65
+ * @deprecated
66
+ */
67
+ properties?: Record<string, string>;
68
+ };
89
69
  };
90
70
  export type CSSSyntaxToken = {
91
- type: number;
92
- value: string;
93
- index: number;
94
- balance: number;
95
- node?: any;
71
+ type: number;
72
+ value: string;
73
+ index: number;
74
+ balance: number;
75
+ node?: any;
96
76
  };
97
- export type CssSyntaxTokenizer = (
98
- token: CSSSyntaxToken | null,
99
- getNextToken: GetNextToken,
100
- match: typeof cssSyntaxMatch,
101
- ) => number;
77
+ export type CssSyntaxTokenizer = (token: CSSSyntaxToken | null, getNextToken: GetNextToken, match: typeof cssSyntaxMatch) => number;
102
78
  export type GetNextToken = (length: number) => CSSSyntaxToken | null;