@yozora/tokenizer-image 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 +88 -6
- package/package.json +8 -8
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/image#readme">@yozora/tokenizer-image</a>
|
|
6
6
|
</h1>
|
|
7
7
|
<div align="center">
|
|
8
8
|
<a href="https://www.npmjs.com/package/@yozora/tokenizer-image">
|
|
@@ -182,53 +182,53 @@ Name | Type | Required | Default
|
|
|
182
182
|
|
|
183
183
|
[live-examples]: https://yozora.guanghechen.com/docs/package/tokenizer-image#live-examples
|
|
184
184
|
[docpage]: https://yozora.guanghechen.com/docs/package/tokenizer-image
|
|
185
|
-
[homepage]: https://github.com/yozorajs/yozora/tree/
|
|
185
|
+
[homepage]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/image#readme
|
|
186
186
|
[gfm-spec]: https://github.github.com/gfm
|
|
187
187
|
[mdast-homepage]: https://github.com/syntax-tree/mdast
|
|
188
188
|
|
|
189
|
-
[@yozora/ast]: https://github.com/yozorajs/yozora/tree/
|
|
190
|
-
[@yozora/ast-util]: https://github.com/yozorajs/yozora/tree/
|
|
191
|
-
[@yozora/character]: https://github.com/yozorajs/yozora/tree/
|
|
192
|
-
[@yozora/eslint-config]: https://github.com/yozorajs/yozora/tree/
|
|
193
|
-
[@yozora/core-parser]: https://github.com/yozorajs/yozora/tree/
|
|
194
|
-
[@yozora/core-tokenizer]: https://github.com/yozorajs/yozora/tree/
|
|
195
|
-
[@yozora/invariant]: https://github.com/yozorajs/yozora/tree/
|
|
196
|
-
[@yozora/jest-for-tokenizer]: https://github.com/yozorajs/yozora/tree/
|
|
197
|
-
[@yozora/parser]: https://github.com/yozorajs/yozora/tree/
|
|
198
|
-
[@yozora/parser-gfm]: https://github.com/yozorajs/yozora/tree/
|
|
199
|
-
[@yozora/parser-gfm-ex]: https://github.com/yozorajs/yozora/tree/
|
|
200
|
-
[@yozora/template-tokenizer]: https://github.com/yozorajs/yozora/tree/
|
|
201
|
-
[@yozora/tokenizer-admonition]: https://github.com/yozorajs/yozora/tree/
|
|
202
|
-
[@yozora/tokenizer-autolink]: https://github.com/yozorajs/yozora/tree/
|
|
203
|
-
[@yozora/tokenizer-autolink-extension]: https://github.com/yozorajs/yozora/tree/
|
|
204
|
-
[@yozora/tokenizer-blockquote]: https://github.com/yozorajs/yozora/tree/
|
|
205
|
-
[@yozora/tokenizer-break]: https://github.com/yozorajs/yozora/tree/
|
|
206
|
-
[@yozora/tokenizer-definition]: https://github.com/yozorajs/yozora/tree/
|
|
207
|
-
[@yozora/tokenizer-delete]: https://github.com/yozorajs/yozora/tree/
|
|
208
|
-
[@yozora/tokenizer-ecma-import]: https://github.com/yozorajs/yozora/tree/
|
|
209
|
-
[@yozora/tokenizer-emphasis]: https://github.com/yozorajs/yozora/tree/
|
|
210
|
-
[@yozora/tokenizer-fenced-block]: https://github.com/yozorajs/yozora/tree/
|
|
211
|
-
[@yozora/tokenizer-fenced-code]: https://github.com/yozorajs/yozora/tree/
|
|
212
|
-
[@yozora/tokenizer-footnote]: https://github.com/yozorajs/yozora/tree/
|
|
213
|
-
[@yozora/tokenizer-footnote-definition]: https://github.com/yozorajs/yozora/tree/
|
|
214
|
-
[@yozora/tokenizer-footnote-reference]: https://github.com/yozorajs/yozora/tree/
|
|
215
|
-
[@yozora/tokenizer-heading]: https://github.com/yozorajs/yozora/tree/
|
|
216
|
-
[@yozora/tokenizer-html-block]: https://github.com/yozorajs/yozora/tree/
|
|
217
|
-
[@yozora/tokenizer-html-inline]: https://github.com/yozorajs/yozora/tree/
|
|
218
|
-
[@yozora/tokenizer-image]: https://github.com/yozorajs/yozora/tree/
|
|
219
|
-
[@yozora/tokenizer-image-reference]: https://github.com/yozorajs/yozora/tree/
|
|
220
|
-
[@yozora/tokenizer-indented-code]: https://github.com/yozorajs/yozora/tree/
|
|
221
|
-
[@yozora/tokenizer-inline-code]: https://github.com/yozorajs/yozora/tree/
|
|
222
|
-
[@yozora/tokenizer-inline-math]: https://github.com/yozorajs/yozora/tree/
|
|
223
|
-
[@yozora/tokenizer-link]: https://github.com/yozorajs/yozora/tree/
|
|
224
|
-
[@yozora/tokenizer-link-reference]: https://github.com/yozorajs/yozora/tree/
|
|
225
|
-
[@yozora/tokenizer-list]: https://github.com/yozorajs/yozora/tree/
|
|
226
|
-
[@yozora/tokenizer-math]: https://github.com/yozorajs/yozora/tree/
|
|
227
|
-
[@yozora/tokenizer-paragraph]: https://github.com/yozorajs/yozora/tree/
|
|
228
|
-
[@yozora/tokenizer-setext-heading]: https://github.com/yozorajs/yozora/tree/
|
|
229
|
-
[@yozora/tokenizer-table]: https://github.com/yozorajs/yozora/tree/
|
|
230
|
-
[@yozora/tokenizer-text]: https://github.com/yozorajs/yozora/tree/
|
|
231
|
-
[@yozora/tokenizer-thematic-break]: https://github.com/yozorajs/yozora/tree/
|
|
189
|
+
[@yozora/ast]: https://github.com/yozorajs/yozora/tree/release-2.x.x/packages/ast#readme
|
|
190
|
+
[@yozora/ast-util]: https://github.com/yozorajs/yozora/tree/release-2.x.x/packages/ast-util#readme
|
|
191
|
+
[@yozora/character]: https://github.com/yozorajs/yozora/tree/release-2.x.x/packages/character#readme
|
|
192
|
+
[@yozora/eslint-config]: https://github.com/yozorajs/yozora/tree/release-2.x.x/packages/eslint-config#readme
|
|
193
|
+
[@yozora/core-parser]: https://github.com/yozorajs/yozora/tree/release-2.x.x/packages/core-parser#readme
|
|
194
|
+
[@yozora/core-tokenizer]: https://github.com/yozorajs/yozora/tree/release-2.x.x/packages/core-tokenizer#readme
|
|
195
|
+
[@yozora/invariant]: https://github.com/yozorajs/yozora/tree/release-2.x.x/packages/invariant#readme
|
|
196
|
+
[@yozora/jest-for-tokenizer]: https://github.com/yozorajs/yozora/tree/release-2.x.x/packages/jest-for-tokenizer#readme
|
|
197
|
+
[@yozora/parser]: https://github.com/yozorajs/yozora/tree/release-2.x.x/packages/parser#readme
|
|
198
|
+
[@yozora/parser-gfm]: https://github.com/yozorajs/yozora/tree/release-2.x.x/packages/parser-gfm#readme
|
|
199
|
+
[@yozora/parser-gfm-ex]: https://github.com/yozorajs/yozora/tree/release-2.x.x/packages/parser-gfm-ex#readme
|
|
200
|
+
[@yozora/template-tokenizer]: https://github.com/yozorajs/yozora/tree/release-2.x.x/packages/template-tokenizer#readme
|
|
201
|
+
[@yozora/tokenizer-admonition]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/admonition#readme
|
|
202
|
+
[@yozora/tokenizer-autolink]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/autolink#readme
|
|
203
|
+
[@yozora/tokenizer-autolink-extension]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/autolink-extension#readme
|
|
204
|
+
[@yozora/tokenizer-blockquote]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/blockquote#readme
|
|
205
|
+
[@yozora/tokenizer-break]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/break#readme
|
|
206
|
+
[@yozora/tokenizer-definition]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/definition#readme
|
|
207
|
+
[@yozora/tokenizer-delete]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/delete#readme
|
|
208
|
+
[@yozora/tokenizer-ecma-import]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/ecma-import#readme
|
|
209
|
+
[@yozora/tokenizer-emphasis]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/emphasis#readme
|
|
210
|
+
[@yozora/tokenizer-fenced-block]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/fenced-block#readme
|
|
211
|
+
[@yozora/tokenizer-fenced-code]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/fenced-code#readme
|
|
212
|
+
[@yozora/tokenizer-footnote]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/footnote#readme
|
|
213
|
+
[@yozora/tokenizer-footnote-definition]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/footnote-definition#readme
|
|
214
|
+
[@yozora/tokenizer-footnote-reference]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/footnote-reference#readme
|
|
215
|
+
[@yozora/tokenizer-heading]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/heading#readme
|
|
216
|
+
[@yozora/tokenizer-html-block]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/html-block#readme
|
|
217
|
+
[@yozora/tokenizer-html-inline]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/html-inline#readme
|
|
218
|
+
[@yozora/tokenizer-image]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/image#readme
|
|
219
|
+
[@yozora/tokenizer-image-reference]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/image-reference#readme
|
|
220
|
+
[@yozora/tokenizer-indented-code]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/indented-code#readme
|
|
221
|
+
[@yozora/tokenizer-inline-code]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/inline-code#readme
|
|
222
|
+
[@yozora/tokenizer-inline-math]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/inline-math#readme
|
|
223
|
+
[@yozora/tokenizer-link]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/link#readme
|
|
224
|
+
[@yozora/tokenizer-link-reference]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/link-reference#readme
|
|
225
|
+
[@yozora/tokenizer-list]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/list#readme
|
|
226
|
+
[@yozora/tokenizer-math]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/math#readme
|
|
227
|
+
[@yozora/tokenizer-paragraph]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/paragraph#readme
|
|
228
|
+
[@yozora/tokenizer-setext-heading]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/setext-heading#readme
|
|
229
|
+
[@yozora/tokenizer-table]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/table#readme
|
|
230
|
+
[@yozora/tokenizer-text]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/text#readme
|
|
231
|
+
[@yozora/tokenizer-thematic-break]: https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/thematic-break#readme
|
|
232
232
|
|
|
233
233
|
[@yozora/react-admonition]: https://github.com/yozorajs/yozora-react/tree/main/packages/admonition#readme
|
|
234
234
|
[@yozora/react-blockquote]: https://github.com/yozorajs/yozora-react/tree/main/packages/blockquote#readme
|
package/lib/types/index.d.ts
CHANGED
|
@@ -1,6 +1,88 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
1
|
+
import { Node, ImageType, Image } from '@yozora/ast';
|
|
2
|
+
import { IPartialYastInlineToken, ITokenizer, IBaseInlineTokenizerProps, IYastTokenDelimiter, IMatchInlineHookCreator, IParseInlineHookCreator, BaseInlineTokenizer, IInlineTokenizer } from '@yozora/core-tokenizer';
|
|
3
|
+
import { INodeInterval } from '@yozora/character';
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* calc alt
|
|
7
|
+
* An image description has inline elements as its contents. When an image
|
|
8
|
+
* is rendered to HTML, this is standardly used as the image’s alt attribute
|
|
9
|
+
* @see https://github.github.com/gfm/#example-582
|
|
10
|
+
*/
|
|
11
|
+
declare function calcImageAlt(nodes: ReadonlyArray<Node>): string;
|
|
12
|
+
|
|
13
|
+
declare type T = ImageType;
|
|
14
|
+
declare type INode = Image;
|
|
15
|
+
declare const uniqueName = "@yozora/tokenizer-image";
|
|
16
|
+
/**
|
|
17
|
+
* An image token.
|
|
18
|
+
*/
|
|
19
|
+
interface IToken extends IPartialYastInlineToken<T> {
|
|
20
|
+
/**
|
|
21
|
+
* Link destination interval.
|
|
22
|
+
*/
|
|
23
|
+
destinationContent?: INodeInterval;
|
|
24
|
+
/**
|
|
25
|
+
* Link title interval.
|
|
26
|
+
*/
|
|
27
|
+
titleContent?: INodeInterval;
|
|
28
|
+
}
|
|
29
|
+
interface IDelimiter extends IYastTokenDelimiter {
|
|
30
|
+
/**
|
|
31
|
+
* IDelimiter type.
|
|
32
|
+
*/
|
|
33
|
+
type: 'opener' | 'closer';
|
|
34
|
+
/**
|
|
35
|
+
* link destination
|
|
36
|
+
*/
|
|
37
|
+
destinationContent?: INodeInterval;
|
|
38
|
+
/**
|
|
39
|
+
* link title
|
|
40
|
+
*/
|
|
41
|
+
titleContent?: INodeInterval;
|
|
42
|
+
}
|
|
43
|
+
declare type IThis = ITokenizer;
|
|
44
|
+
declare type ITokenizerProps = Partial<IBaseInlineTokenizerProps>;
|
|
45
|
+
|
|
46
|
+
/**
|
|
47
|
+
* Syntax for images is like the syntax for links, with one difference.
|
|
48
|
+
* Instead of link text, we have an image description.
|
|
49
|
+
* The rules for this are the same as for link text, except that
|
|
50
|
+
*
|
|
51
|
+
* a) an image description starts with ''
|
|
66
|
+
* - '](url "title")'
|
|
67
|
+
* - '](<url>)'
|
|
68
|
+
* - '](<url> "title")'
|
|
69
|
+
*
|
|
70
|
+
* @see https://github.com/syntax-tree/mdast#image
|
|
71
|
+
* @see https://github.github.com/gfm/#images
|
|
72
|
+
*/
|
|
73
|
+
declare const match: IMatchInlineHookCreator<T, IDelimiter, IToken, IThis>;
|
|
74
|
+
|
|
75
|
+
declare const parse: IParseInlineHookCreator<T, IToken, INode, IThis>;
|
|
76
|
+
|
|
77
|
+
/**
|
|
78
|
+
* Lexical Analyzer for InlineImage.
|
|
79
|
+
* @see https://github.com/syntax-tree/mdast#image
|
|
80
|
+
* @see https://github.github.com/gfm/#images
|
|
81
|
+
*/
|
|
82
|
+
declare class ImageTokenizer extends BaseInlineTokenizer<T, IDelimiter, IToken, INode, IThis> implements IInlineTokenizer<T, IDelimiter, IToken, INode, IThis> {
|
|
83
|
+
constructor(props?: ITokenizerProps);
|
|
84
|
+
readonly match: IMatchInlineHookCreator<T, IDelimiter, IToken, IThis>;
|
|
85
|
+
readonly parse: IParseInlineHookCreator<T, IToken, INode, IThis>;
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
export { IThis as IImageHookContext, IToken as IImageToken, ITokenizerProps as IImageTokenizerProps, ImageTokenizer, uniqueName as ImageTokenizerName, calcImageAlt, ImageTokenizer as default, match as imageMatch, parse as imageParse };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@yozora/tokenizer-image",
|
|
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/image"
|
|
12
12
|
},
|
|
13
|
-
"homepage": "https://
|
|
13
|
+
"homepage": "https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/image",
|
|
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,10 +35,10 @@
|
|
|
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
|
|
41
|
-
"@yozora/tokenizer-link": "^2.0.2
|
|
38
|
+
"@yozora/ast": "^2.0.2",
|
|
39
|
+
"@yozora/character": "^2.0.2",
|
|
40
|
+
"@yozora/core-tokenizer": "^2.0.2",
|
|
41
|
+
"@yozora/tokenizer-link": "^2.0.2"
|
|
42
42
|
},
|
|
43
|
-
"gitHead": "
|
|
43
|
+
"gitHead": "6911295e9eacfa29563fe93494704190e50625fd"
|
|
44
44
|
}
|