@yozora/tokenizer-break 2.0.1 → 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 +61 -5
- 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/break#readme">@yozora/tokenizer-break</a>
|
|
6
6
|
</h1>
|
|
7
7
|
<div align="center">
|
|
8
8
|
<a href="https://www.npmjs.com/package/@yozora/tokenizer-break">
|
|
@@ -209,53 +209,53 @@ Name | Type | Required | Default
|
|
|
209
209
|
|
|
210
210
|
[live-examples]: https://yozora.guanghechen.com/docs/package/tokenizer-break#live-examples
|
|
211
211
|
[docpage]: https://yozora.guanghechen.com/docs/package/tokenizer-break
|
|
212
|
-
[homepage]: https://github.com/yozorajs/yozora/tree/
|
|
212
|
+
[homepage]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/break#readme
|
|
213
213
|
[gfm-spec]: https://github.github.com/gfm
|
|
214
214
|
[mdast-homepage]: https://github.com/syntax-tree/mdast
|
|
215
215
|
|
|
216
|
-
[@yozora/ast]: https://github.com/yozorajs/yozora/tree/
|
|
217
|
-
[@yozora/ast-util]: https://github.com/yozorajs/yozora/tree/
|
|
218
|
-
[@yozora/character]: https://github.com/yozorajs/yozora/tree/
|
|
219
|
-
[@yozora/eslint-config]: https://github.com/yozorajs/yozora/tree/
|
|
220
|
-
[@yozora/core-parser]: https://github.com/yozorajs/yozora/tree/
|
|
221
|
-
[@yozora/core-tokenizer]: https://github.com/yozorajs/yozora/tree/
|
|
222
|
-
[@yozora/invariant]: https://github.com/yozorajs/yozora/tree/
|
|
223
|
-
[@yozora/jest-for-tokenizer]: https://github.com/yozorajs/yozora/tree/
|
|
224
|
-
[@yozora/parser]: https://github.com/yozorajs/yozora/tree/
|
|
225
|
-
[@yozora/parser-gfm]: https://github.com/yozorajs/yozora/tree/
|
|
226
|
-
[@yozora/parser-gfm-ex]: https://github.com/yozorajs/yozora/tree/
|
|
227
|
-
[@yozora/template-tokenizer]: https://github.com/yozorajs/yozora/tree/
|
|
228
|
-
[@yozora/tokenizer-admonition]: https://github.com/yozorajs/yozora/tree/
|
|
229
|
-
[@yozora/tokenizer-autolink]: https://github.com/yozorajs/yozora/tree/
|
|
230
|
-
[@yozora/tokenizer-autolink-extension]: https://github.com/yozorajs/yozora/tree/
|
|
231
|
-
[@yozora/tokenizer-blockquote]: https://github.com/yozorajs/yozora/tree/
|
|
232
|
-
[@yozora/tokenizer-break]: https://github.com/yozorajs/yozora/tree/
|
|
233
|
-
[@yozora/tokenizer-definition]: https://github.com/yozorajs/yozora/tree/
|
|
234
|
-
[@yozora/tokenizer-delete]: https://github.com/yozorajs/yozora/tree/
|
|
235
|
-
[@yozora/tokenizer-ecma-import]: https://github.com/yozorajs/yozora/tree/
|
|
236
|
-
[@yozora/tokenizer-emphasis]: https://github.com/yozorajs/yozora/tree/
|
|
237
|
-
[@yozora/tokenizer-fenced-block]: https://github.com/yozorajs/yozora/tree/
|
|
238
|
-
[@yozora/tokenizer-fenced-code]: https://github.com/yozorajs/yozora/tree/
|
|
239
|
-
[@yozora/tokenizer-footnote]: https://github.com/yozorajs/yozora/tree/
|
|
240
|
-
[@yozora/tokenizer-footnote-definition]: https://github.com/yozorajs/yozora/tree/
|
|
241
|
-
[@yozora/tokenizer-footnote-reference]: https://github.com/yozorajs/yozora/tree/
|
|
242
|
-
[@yozora/tokenizer-heading]: https://github.com/yozorajs/yozora/tree/
|
|
243
|
-
[@yozora/tokenizer-html-block]: https://github.com/yozorajs/yozora/tree/
|
|
244
|
-
[@yozora/tokenizer-html-inline]: https://github.com/yozorajs/yozora/tree/
|
|
245
|
-
[@yozora/tokenizer-image]: https://github.com/yozorajs/yozora/tree/
|
|
246
|
-
[@yozora/tokenizer-image-reference]: https://github.com/yozorajs/yozora/tree/
|
|
247
|
-
[@yozora/tokenizer-indented-code]: https://github.com/yozorajs/yozora/tree/
|
|
248
|
-
[@yozora/tokenizer-inline-code]: https://github.com/yozorajs/yozora/tree/
|
|
249
|
-
[@yozora/tokenizer-inline-math]: https://github.com/yozorajs/yozora/tree/
|
|
250
|
-
[@yozora/tokenizer-link]: https://github.com/yozorajs/yozora/tree/
|
|
251
|
-
[@yozora/tokenizer-link-reference]: https://github.com/yozorajs/yozora/tree/
|
|
252
|
-
[@yozora/tokenizer-list]: https://github.com/yozorajs/yozora/tree/
|
|
253
|
-
[@yozora/tokenizer-math]: https://github.com/yozorajs/yozora/tree/
|
|
254
|
-
[@yozora/tokenizer-paragraph]: https://github.com/yozorajs/yozora/tree/
|
|
255
|
-
[@yozora/tokenizer-setext-heading]: https://github.com/yozorajs/yozora/tree/
|
|
256
|
-
[@yozora/tokenizer-table]: https://github.com/yozorajs/yozora/tree/
|
|
257
|
-
[@yozora/tokenizer-text]: https://github.com/yozorajs/yozora/tree/
|
|
258
|
-
[@yozora/tokenizer-thematic-break]: https://github.com/yozorajs/yozora/tree/
|
|
216
|
+
[@yozora/ast]: https://github.com/yozorajs/yozora/tree/release-2.x.x/packages/ast#readme
|
|
217
|
+
[@yozora/ast-util]: https://github.com/yozorajs/yozora/tree/release-2.x.x/packages/ast-util#readme
|
|
218
|
+
[@yozora/character]: https://github.com/yozorajs/yozora/tree/release-2.x.x/packages/character#readme
|
|
219
|
+
[@yozora/eslint-config]: https://github.com/yozorajs/yozora/tree/release-2.x.x/packages/eslint-config#readme
|
|
220
|
+
[@yozora/core-parser]: https://github.com/yozorajs/yozora/tree/release-2.x.x/packages/core-parser#readme
|
|
221
|
+
[@yozora/core-tokenizer]: https://github.com/yozorajs/yozora/tree/release-2.x.x/packages/core-tokenizer#readme
|
|
222
|
+
[@yozora/invariant]: https://github.com/yozorajs/yozora/tree/release-2.x.x/packages/invariant#readme
|
|
223
|
+
[@yozora/jest-for-tokenizer]: https://github.com/yozorajs/yozora/tree/release-2.x.x/packages/jest-for-tokenizer#readme
|
|
224
|
+
[@yozora/parser]: https://github.com/yozorajs/yozora/tree/release-2.x.x/packages/parser#readme
|
|
225
|
+
[@yozora/parser-gfm]: https://github.com/yozorajs/yozora/tree/release-2.x.x/packages/parser-gfm#readme
|
|
226
|
+
[@yozora/parser-gfm-ex]: https://github.com/yozorajs/yozora/tree/release-2.x.x/packages/parser-gfm-ex#readme
|
|
227
|
+
[@yozora/template-tokenizer]: https://github.com/yozorajs/yozora/tree/release-2.x.x/packages/template-tokenizer#readme
|
|
228
|
+
[@yozora/tokenizer-admonition]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/admonition#readme
|
|
229
|
+
[@yozora/tokenizer-autolink]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/autolink#readme
|
|
230
|
+
[@yozora/tokenizer-autolink-extension]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/autolink-extension#readme
|
|
231
|
+
[@yozora/tokenizer-blockquote]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/blockquote#readme
|
|
232
|
+
[@yozora/tokenizer-break]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/break#readme
|
|
233
|
+
[@yozora/tokenizer-definition]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/definition#readme
|
|
234
|
+
[@yozora/tokenizer-delete]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/delete#readme
|
|
235
|
+
[@yozora/tokenizer-ecma-import]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/ecma-import#readme
|
|
236
|
+
[@yozora/tokenizer-emphasis]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/emphasis#readme
|
|
237
|
+
[@yozora/tokenizer-fenced-block]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/fenced-block#readme
|
|
238
|
+
[@yozora/tokenizer-fenced-code]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/fenced-code#readme
|
|
239
|
+
[@yozora/tokenizer-footnote]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/footnote#readme
|
|
240
|
+
[@yozora/tokenizer-footnote-definition]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/footnote-definition#readme
|
|
241
|
+
[@yozora/tokenizer-footnote-reference]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/footnote-reference#readme
|
|
242
|
+
[@yozora/tokenizer-heading]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/heading#readme
|
|
243
|
+
[@yozora/tokenizer-html-block]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/html-block#readme
|
|
244
|
+
[@yozora/tokenizer-html-inline]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/html-inline#readme
|
|
245
|
+
[@yozora/tokenizer-image]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/image#readme
|
|
246
|
+
[@yozora/tokenizer-image-reference]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/image-reference#readme
|
|
247
|
+
[@yozora/tokenizer-indented-code]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/indented-code#readme
|
|
248
|
+
[@yozora/tokenizer-inline-code]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/inline-code#readme
|
|
249
|
+
[@yozora/tokenizer-inline-math]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/inline-math#readme
|
|
250
|
+
[@yozora/tokenizer-link]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/link#readme
|
|
251
|
+
[@yozora/tokenizer-link-reference]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/link-reference#readme
|
|
252
|
+
[@yozora/tokenizer-list]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/list#readme
|
|
253
|
+
[@yozora/tokenizer-math]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/math#readme
|
|
254
|
+
[@yozora/tokenizer-paragraph]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/paragraph#readme
|
|
255
|
+
[@yozora/tokenizer-setext-heading]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/setext-heading#readme
|
|
256
|
+
[@yozora/tokenizer-table]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/table#readme
|
|
257
|
+
[@yozora/tokenizer-text]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/text#readme
|
|
258
|
+
[@yozora/tokenizer-thematic-break]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/thematic-break#readme
|
|
259
259
|
|
|
260
260
|
[@yozora/react-admonition]: https://github.com/yozorajs/yozora-react/tree/main/packages/admonition#readme
|
|
261
261
|
[@yozora/react-blockquote]: https://github.com/yozorajs/yozora-react/tree/main/packages/blockquote#readme
|
package/lib/types/index.d.ts
CHANGED
|
@@ -1,5 +1,61 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
1
|
+
import { IPartialYastInlineToken, ITokenizer, IBaseInlineTokenizerProps, IYastTokenDelimiter, IMatchInlineHookCreator, IParseInlineHookCreator, BaseInlineTokenizer, IInlineTokenizer } from '@yozora/core-tokenizer';
|
|
2
|
+
import { BreakType, Break } from '@yozora/ast';
|
|
3
|
+
|
|
4
|
+
declare type T = BreakType;
|
|
5
|
+
declare type INode = Break;
|
|
6
|
+
declare const uniqueName = "@yozora/tokenizer-break";
|
|
7
|
+
declare type IToken = IPartialYastInlineToken<T>;
|
|
8
|
+
interface IDelimiter extends IYastTokenDelimiter {
|
|
9
|
+
type: 'full';
|
|
10
|
+
/**
|
|
11
|
+
* Line break marker type.
|
|
12
|
+
*/
|
|
13
|
+
markerType: BreakTokenMarkerType;
|
|
14
|
+
}
|
|
15
|
+
declare type IThis = ITokenizer;
|
|
16
|
+
declare type ITokenizerProps = Partial<IBaseInlineTokenizerProps>;
|
|
17
|
+
/**
|
|
18
|
+
* Line break marker type.
|
|
19
|
+
*/
|
|
20
|
+
declare enum BreakTokenMarkerType {
|
|
21
|
+
/**
|
|
22
|
+
* Backslash at the end of the line
|
|
23
|
+
*/
|
|
24
|
+
BACKSLASH = "backslash",
|
|
25
|
+
/**
|
|
26
|
+
* More than two spaces at the end of the line
|
|
27
|
+
*/
|
|
28
|
+
MORE_THAN_TWO_SPACES = "more-than-two-spaces"
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
/**
|
|
32
|
+
* A line break (not in a code span or HTML tag) that is preceded by two or more
|
|
33
|
+
* spaces and does not occur at the end of a block is parsed as a hard line
|
|
34
|
+
* break (rendered in HTML as a <br /> tag)
|
|
35
|
+
* @see https://github.github.com/gfm/#hard-line-breaks
|
|
36
|
+
*
|
|
37
|
+
* A regular line break (not in a code span or HTML tag) that is not preceded
|
|
38
|
+
* by two or more spaces or a backslash is parsed as a softbreak. (A softbreak
|
|
39
|
+
* may be rendered in HTML either as a line ending or as a space. The result
|
|
40
|
+
* will be the same in browsers.
|
|
41
|
+
* @see https://github.github.com/gfm/#soft-line-breaks
|
|
42
|
+
*
|
|
43
|
+
* @see https://github.com/syntax-tree/mdast#break
|
|
44
|
+
*/
|
|
45
|
+
declare const match: IMatchInlineHookCreator<T, IDelimiter, IToken, IThis>;
|
|
46
|
+
|
|
47
|
+
declare const parse: IParseInlineHookCreator<T, IToken, INode, IThis>;
|
|
48
|
+
|
|
49
|
+
/**
|
|
50
|
+
* Lexical Analyzer for a line break.
|
|
51
|
+
* @see https://github.github.com/gfm/#hard-line-breaks
|
|
52
|
+
* @see https://github.github.com/gfm/#soft-line-breaks
|
|
53
|
+
* @see https://github.com/syntax-tree/mdast#break
|
|
54
|
+
*/
|
|
55
|
+
declare class BreakTokenizer extends BaseInlineTokenizer<T, IDelimiter, IToken, INode, IThis> implements IInlineTokenizer<T, IDelimiter, IToken, INode, IThis> {
|
|
56
|
+
constructor(props?: ITokenizerProps);
|
|
57
|
+
readonly match: IMatchInlineHookCreator<T, IDelimiter, IToken, IThis>;
|
|
58
|
+
readonly parse: IParseInlineHookCreator<T, IToken, INode, IThis>;
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
export { BreakTokenizer, uniqueName as BreakTokenizerName, IThis as IBreakHookContext, IToken as IBreakToken, ITokenizerProps as IBreakTokenizerProps, match as breakMatch, parse as breakParse, BreakTokenizer as default };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@yozora/tokenizer-break",
|
|
3
|
-
"version": "2.0.
|
|
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/break"
|
|
12
12
|
},
|
|
13
|
-
"homepage": "https://
|
|
13
|
+
"homepage": "https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/break",
|
|
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.
|
|
39
|
-
"@yozora/character": "^2.0.
|
|
40
|
-
"@yozora/core-tokenizer": "^2.0.
|
|
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
|
}
|