@yozora/tokenizer-list 2.0.2-alpha.0 → 2.0.2
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.
- package/README.md +45 -45
- package/lib/types/index.d.ts +85 -3
- package/package.json +7 -7
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
<header>
|
|
4
4
|
<h1 align="center">
|
|
5
|
-
<a href="https://github.com/yozorajs/yozora/tree/
|
|
5
|
+
<a href="https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/list#readme">@yozora/tokenizer-list</a>
|
|
6
6
|
</h1>
|
|
7
7
|
<div align="center">
|
|
8
8
|
<a href="https://www.npmjs.com/package/@yozora/tokenizer-list">
|
|
@@ -262,54 +262,54 @@ Name | Type | Required | Default
|
|
|
262
262
|
|
|
263
263
|
[live-examples]: https://yozora.guanghechen.com/docs/package/tokenizer-list#live-examples
|
|
264
264
|
[docpage]: https://yozora.guanghechen.com/docs/package/tokenizer-list
|
|
265
|
-
[homepage]: https://github.com/yozorajs/yozora/tree/
|
|
265
|
+
[homepage]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/list#readme
|
|
266
266
|
[gfm-spec]: https://github.github.com/gfm
|
|
267
267
|
[mdast-homepage]: https://github.com/syntax-tree/mdast#list
|
|
268
268
|
[mdast-homepage:list-item]: https://github.com/syntax-tree/mdast#listitem
|
|
269
269
|
|
|
270
|
-
[@yozora/ast]: https://github.com/yozorajs/yozora/tree/
|
|
271
|
-
[@yozora/ast-util]: https://github.com/yozorajs/yozora/tree/
|
|
272
|
-
[@yozora/character]: https://github.com/yozorajs/yozora/tree/
|
|
273
|
-
[@yozora/eslint-config]: https://github.com/yozorajs/yozora/tree/
|
|
274
|
-
[@yozora/core-parser]: https://github.com/yozorajs/yozora/tree/
|
|
275
|
-
[@yozora/core-tokenizer]: https://github.com/yozorajs/yozora/tree/
|
|
276
|
-
[@yozora/invariant]: https://github.com/yozorajs/yozora/tree/
|
|
277
|
-
[@yozora/jest-for-tokenizer]: https://github.com/yozorajs/yozora/tree/
|
|
278
|
-
[@yozora/parser]: https://github.com/yozorajs/yozora/tree/
|
|
279
|
-
[@yozora/parser-gfm]: https://github.com/yozorajs/yozora/tree/
|
|
280
|
-
[@yozora/parser-gfm-ex]: https://github.com/yozorajs/yozora/tree/
|
|
281
|
-
[@yozora/template-tokenizer]: https://github.com/yozorajs/yozora/tree/
|
|
282
|
-
[@yozora/tokenizer-admonition]: https://github.com/yozorajs/yozora/tree/
|
|
283
|
-
[@yozora/tokenizer-autolink]: https://github.com/yozorajs/yozora/tree/
|
|
284
|
-
[@yozora/tokenizer-autolink-extension]: https://github.com/yozorajs/yozora/tree/
|
|
285
|
-
[@yozora/tokenizer-blockquote]: https://github.com/yozorajs/yozora/tree/
|
|
286
|
-
[@yozora/tokenizer-break]: https://github.com/yozorajs/yozora/tree/
|
|
287
|
-
[@yozora/tokenizer-definition]: https://github.com/yozorajs/yozora/tree/
|
|
288
|
-
[@yozora/tokenizer-delete]: https://github.com/yozorajs/yozora/tree/
|
|
289
|
-
[@yozora/tokenizer-ecma-import]: https://github.com/yozorajs/yozora/tree/
|
|
290
|
-
[@yozora/tokenizer-emphasis]: https://github.com/yozorajs/yozora/tree/
|
|
291
|
-
[@yozora/tokenizer-fenced-block]: https://github.com/yozorajs/yozora/tree/
|
|
292
|
-
[@yozora/tokenizer-fenced-code]: https://github.com/yozorajs/yozora/tree/
|
|
293
|
-
[@yozora/tokenizer-footnote]: https://github.com/yozorajs/yozora/tree/
|
|
294
|
-
[@yozora/tokenizer-footnote-definition]: https://github.com/yozorajs/yozora/tree/
|
|
295
|
-
[@yozora/tokenizer-footnote-reference]: https://github.com/yozorajs/yozora/tree/
|
|
296
|
-
[@yozora/tokenizer-heading]: https://github.com/yozorajs/yozora/tree/
|
|
297
|
-
[@yozora/tokenizer-html-block]: https://github.com/yozorajs/yozora/tree/
|
|
298
|
-
[@yozora/tokenizer-html-inline]: https://github.com/yozorajs/yozora/tree/
|
|
299
|
-
[@yozora/tokenizer-image]: https://github.com/yozorajs/yozora/tree/
|
|
300
|
-
[@yozora/tokenizer-image-reference]: https://github.com/yozorajs/yozora/tree/
|
|
301
|
-
[@yozora/tokenizer-indented-code]: https://github.com/yozorajs/yozora/tree/
|
|
302
|
-
[@yozora/tokenizer-inline-code]: https://github.com/yozorajs/yozora/tree/
|
|
303
|
-
[@yozora/tokenizer-inline-math]: https://github.com/yozorajs/yozora/tree/
|
|
304
|
-
[@yozora/tokenizer-link]: https://github.com/yozorajs/yozora/tree/
|
|
305
|
-
[@yozora/tokenizer-link-reference]: https://github.com/yozorajs/yozora/tree/
|
|
306
|
-
[@yozora/tokenizer-list]: https://github.com/yozorajs/yozora/tree/
|
|
307
|
-
[@yozora/tokenizer-math]: https://github.com/yozorajs/yozora/tree/
|
|
308
|
-
[@yozora/tokenizer-paragraph]: https://github.com/yozorajs/yozora/tree/
|
|
309
|
-
[@yozora/tokenizer-setext-heading]: https://github.com/yozorajs/yozora/tree/
|
|
310
|
-
[@yozora/tokenizer-table]: https://github.com/yozorajs/yozora/tree/
|
|
311
|
-
[@yozora/tokenizer-text]: https://github.com/yozorajs/yozora/tree/
|
|
312
|
-
[@yozora/tokenizer-thematic-break]: https://github.com/yozorajs/yozora/tree/
|
|
270
|
+
[@yozora/ast]: https://github.com/yozorajs/yozora/tree/release-2.x.x/packages/ast#readme
|
|
271
|
+
[@yozora/ast-util]: https://github.com/yozorajs/yozora/tree/release-2.x.x/packages/ast-util#readme
|
|
272
|
+
[@yozora/character]: https://github.com/yozorajs/yozora/tree/release-2.x.x/packages/character#readme
|
|
273
|
+
[@yozora/eslint-config]: https://github.com/yozorajs/yozora/tree/release-2.x.x/packages/eslint-config#readme
|
|
274
|
+
[@yozora/core-parser]: https://github.com/yozorajs/yozora/tree/release-2.x.x/packages/core-parser#readme
|
|
275
|
+
[@yozora/core-tokenizer]: https://github.com/yozorajs/yozora/tree/release-2.x.x/packages/core-tokenizer#readme
|
|
276
|
+
[@yozora/invariant]: https://github.com/yozorajs/yozora/tree/release-2.x.x/packages/invariant#readme
|
|
277
|
+
[@yozora/jest-for-tokenizer]: https://github.com/yozorajs/yozora/tree/release-2.x.x/packages/jest-for-tokenizer#readme
|
|
278
|
+
[@yozora/parser]: https://github.com/yozorajs/yozora/tree/release-2.x.x/packages/parser#readme
|
|
279
|
+
[@yozora/parser-gfm]: https://github.com/yozorajs/yozora/tree/release-2.x.x/packages/parser-gfm#readme
|
|
280
|
+
[@yozora/parser-gfm-ex]: https://github.com/yozorajs/yozora/tree/release-2.x.x/packages/parser-gfm-ex#readme
|
|
281
|
+
[@yozora/template-tokenizer]: https://github.com/yozorajs/yozora/tree/release-2.x.x/packages/template-tokenizer#readme
|
|
282
|
+
[@yozora/tokenizer-admonition]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/admonition#readme
|
|
283
|
+
[@yozora/tokenizer-autolink]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/autolink#readme
|
|
284
|
+
[@yozora/tokenizer-autolink-extension]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/autolink-extension#readme
|
|
285
|
+
[@yozora/tokenizer-blockquote]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/blockquote#readme
|
|
286
|
+
[@yozora/tokenizer-break]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/break#readme
|
|
287
|
+
[@yozora/tokenizer-definition]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/definition#readme
|
|
288
|
+
[@yozora/tokenizer-delete]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/delete#readme
|
|
289
|
+
[@yozora/tokenizer-ecma-import]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/ecma-import#readme
|
|
290
|
+
[@yozora/tokenizer-emphasis]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/emphasis#readme
|
|
291
|
+
[@yozora/tokenizer-fenced-block]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/fenced-block#readme
|
|
292
|
+
[@yozora/tokenizer-fenced-code]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/fenced-code#readme
|
|
293
|
+
[@yozora/tokenizer-footnote]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/footnote#readme
|
|
294
|
+
[@yozora/tokenizer-footnote-definition]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/footnote-definition#readme
|
|
295
|
+
[@yozora/tokenizer-footnote-reference]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/footnote-reference#readme
|
|
296
|
+
[@yozora/tokenizer-heading]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/heading#readme
|
|
297
|
+
[@yozora/tokenizer-html-block]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/html-block#readme
|
|
298
|
+
[@yozora/tokenizer-html-inline]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/html-inline#readme
|
|
299
|
+
[@yozora/tokenizer-image]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/image#readme
|
|
300
|
+
[@yozora/tokenizer-image-reference]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/image-reference#readme
|
|
301
|
+
[@yozora/tokenizer-indented-code]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/indented-code#readme
|
|
302
|
+
[@yozora/tokenizer-inline-code]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/inline-code#readme
|
|
303
|
+
[@yozora/tokenizer-inline-math]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/inline-math#readme
|
|
304
|
+
[@yozora/tokenizer-link]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/link#readme
|
|
305
|
+
[@yozora/tokenizer-link-reference]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/link-reference#readme
|
|
306
|
+
[@yozora/tokenizer-list]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/list#readme
|
|
307
|
+
[@yozora/tokenizer-math]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/math#readme
|
|
308
|
+
[@yozora/tokenizer-paragraph]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/paragraph#readme
|
|
309
|
+
[@yozora/tokenizer-setext-heading]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/setext-heading#readme
|
|
310
|
+
[@yozora/tokenizer-table]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/table#readme
|
|
311
|
+
[@yozora/tokenizer-text]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/text#readme
|
|
312
|
+
[@yozora/tokenizer-thematic-break]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/thematic-break#readme
|
|
313
313
|
|
|
314
314
|
[@yozora/react-admonition]: https://github.com/yozorajs/yozora-react/tree/main/packages/admonition#readme
|
|
315
315
|
[@yozora/react-blockquote]: https://github.com/yozorajs/yozora-react/tree/main/packages/blockquote#readme
|
package/lib/types/index.d.ts
CHANGED
|
@@ -1,3 +1,85 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
1
|
+
import { TaskStatus, NodeType, ListType, List } from '@yozora/ast';
|
|
2
|
+
import { IPartialYastBlockToken, IYastBlockToken, IBaseBlockTokenizerProps, ITokenizer, BaseBlockTokenizer, IBlockTokenizer, IMatchBlockHookCreator, IParseBlockHookCreator } from '@yozora/core-tokenizer';
|
|
3
|
+
|
|
4
|
+
declare type T = ListType;
|
|
5
|
+
declare type INode = List;
|
|
6
|
+
declare const uniqueName = "@yozora/tokenizer-list";
|
|
7
|
+
interface IToken extends IPartialYastBlockToken<T> {
|
|
8
|
+
/**
|
|
9
|
+
* Is it an ordered list item.
|
|
10
|
+
*/
|
|
11
|
+
ordered: boolean;
|
|
12
|
+
/**
|
|
13
|
+
* Marker of bullet list-item, or a delimiter of ordered list-item.
|
|
14
|
+
*/
|
|
15
|
+
marker: number;
|
|
16
|
+
/**
|
|
17
|
+
* Marker type of the list.
|
|
18
|
+
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/ol#attr-type
|
|
19
|
+
*/
|
|
20
|
+
orderType?: '1' | 'a' | 'A' | 'i' | 'I';
|
|
21
|
+
/**
|
|
22
|
+
* Serial number of ordered list-item.
|
|
23
|
+
*/
|
|
24
|
+
order?: number;
|
|
25
|
+
/**
|
|
26
|
+
* Status of a todo task.
|
|
27
|
+
*/
|
|
28
|
+
status?: TaskStatus;
|
|
29
|
+
/**
|
|
30
|
+
* Indent of a list item.
|
|
31
|
+
*/
|
|
32
|
+
indent: number;
|
|
33
|
+
/**
|
|
34
|
+
* list-item 起始的空行数量
|
|
35
|
+
* The number of blank lines at the beginning of a list-item
|
|
36
|
+
*/
|
|
37
|
+
countOfTopBlankLine: number;
|
|
38
|
+
/**
|
|
39
|
+
* Child token nodes.
|
|
40
|
+
*/
|
|
41
|
+
children: IYastBlockToken[];
|
|
42
|
+
}
|
|
43
|
+
interface IThis extends ITokenizer {
|
|
44
|
+
/**
|
|
45
|
+
* Specify an array of Node types that could not be interrupted
|
|
46
|
+
* by this ITokenizer if the current list-item is empty.
|
|
47
|
+
* @see https://github.github.com/gfm/#example-263
|
|
48
|
+
*/
|
|
49
|
+
readonly emptyItemCouldNotInterruptedTypes: ReadonlyArray<NodeType>;
|
|
50
|
+
/**
|
|
51
|
+
* Should enable task list item (extension).
|
|
52
|
+
*/
|
|
53
|
+
readonly enableTaskListItem: boolean;
|
|
54
|
+
}
|
|
55
|
+
interface ITokenizerProps extends Partial<IBaseBlockTokenizerProps> {
|
|
56
|
+
/**
|
|
57
|
+
* Specify an array of Node types that could not be interrupted
|
|
58
|
+
* by this ITokenizer if the current list-item is empty.
|
|
59
|
+
* @see https://github.github.com/gfm/#example-263
|
|
60
|
+
*/
|
|
61
|
+
readonly emptyItemCouldNotInterruptedTypes?: NodeType[];
|
|
62
|
+
/**
|
|
63
|
+
* Should enable task list item (extension).
|
|
64
|
+
*/
|
|
65
|
+
readonly enableTaskListItem?: boolean;
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
/**
|
|
69
|
+
* Lexical Analyzer for List.
|
|
70
|
+
*
|
|
71
|
+
* A list is a sequence of one or more list items of the same type.
|
|
72
|
+
* The list items may be separated by any number of blank lines.
|
|
73
|
+
*
|
|
74
|
+
* @see https://github.com/syntax-tree/mdast#list
|
|
75
|
+
* @see https://github.github.com/gfm/#list
|
|
76
|
+
*/
|
|
77
|
+
declare class ListTokenizer extends BaseBlockTokenizer<T, IToken, INode, IThis> implements IBlockTokenizer<T, IToken, INode, IThis> {
|
|
78
|
+
constructor(props?: ITokenizerProps);
|
|
79
|
+
readonly enableTaskListItem: boolean;
|
|
80
|
+
readonly emptyItemCouldNotInterruptedTypes: ReadonlyArray<NodeType>;
|
|
81
|
+
readonly match: IMatchBlockHookCreator<T, IToken, IThis>;
|
|
82
|
+
readonly parse: IParseBlockHookCreator<T, IToken, INode, IThis>;
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
export { IToken as IListToken, ITokenizerProps as IListTokenizerProps, ListTokenizer, uniqueName as ListTokenizerName, ListTokenizer as default };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@yozora/tokenizer-list",
|
|
3
|
-
"version": "2.0.2
|
|
3
|
+
"version": "2.0.2",
|
|
4
4
|
"author": {
|
|
5
5
|
"name": "guanghechen",
|
|
6
6
|
"url": "https://github.com/guanghechen/"
|
|
@@ -10,14 +10,14 @@
|
|
|
10
10
|
"url": "https://github.com/yozorajs/yozora.git",
|
|
11
11
|
"directory": "tokenizers/list"
|
|
12
12
|
},
|
|
13
|
-
"homepage": "https://
|
|
13
|
+
"homepage": "https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/list",
|
|
14
14
|
"main": "lib/cjs/index.js",
|
|
15
15
|
"module": "lib/esm/index.js",
|
|
16
16
|
"types": "lib/types/index.d.ts",
|
|
17
17
|
"source": "src/index.ts",
|
|
18
18
|
"license": "MIT",
|
|
19
19
|
"engines": {
|
|
20
|
-
"node": ">=
|
|
20
|
+
"node": ">= 16.0.0"
|
|
21
21
|
},
|
|
22
22
|
"files": [
|
|
23
23
|
"lib/",
|
|
@@ -35,9 +35,9 @@
|
|
|
35
35
|
"test": "cross-env TS_NODE_FILES=true jest --config ../../jest.config.js --rootDir ."
|
|
36
36
|
},
|
|
37
37
|
"dependencies": {
|
|
38
|
-
"@yozora/ast": "^2.0.2
|
|
39
|
-
"@yozora/character": "^2.0.2
|
|
40
|
-
"@yozora/core-tokenizer": "^2.0.2
|
|
38
|
+
"@yozora/ast": "^2.0.2",
|
|
39
|
+
"@yozora/character": "^2.0.2",
|
|
40
|
+
"@yozora/core-tokenizer": "^2.0.2"
|
|
41
41
|
},
|
|
42
|
-
"gitHead": "
|
|
42
|
+
"gitHead": "6911295e9eacfa29563fe93494704190e50625fd"
|
|
43
43
|
}
|