@yozora/tokenizer-image-reference 1.3.0 → 2.0.0-alpha.3

package/README.md

@@ -84,14 +84,14 @@ so you can use `YozoraParser` / `GfmExParser` / `GfmParser` directly.
 registered in *YastParser* as a plugin-in before it can be used.
 
 ```typescript {4,9}
-import { DefaultYastParser } from '@yozora/core-parser'
+import { DefaultParser } from '@yozora/core-parser'
 import ParagraphTokenizer from '@yozora/tokenizer-paragraph'
 import TextTokenizer from '@yozora/tokenizer-text'
 import ImageReferenceTokenizer from '@yozora/tokenizer-image-reference'
 
-const parser = new DefaultYastParser()
-  .useBlockFallbackTokenizer(new ParagraphTokenizer())
-  .useInlineFallbackTokenizer(new TextTokenizer())
+const parser = new DefaultParser()
+  .useFallbackTokenizer(new ParagraphTokenizer())
+  .useFallbackTokenizer(new TextTokenizer())
   .useTokenizer(new ImageReferenceTokenizer())
 
 // parse source markdown content
@@ -231,7 +231,6 @@ Name              | Type        | Required  | Default
 [@yozora/tokenizer-link]:                     https://github.com/yozorajs/yozora/tree/main/tokenizers/link#readme
 [@yozora/tokenizer-link-reference]:           https://github.com/yozorajs/yozora/tree/main/tokenizers/link-reference#readme
 [@yozora/tokenizer-list]:                     https://github.com/yozorajs/yozora/tree/main/tokenizers/list#readme
-[@yozora/tokenizer-list-item]:                https://github.com/yozorajs/yozora/tree/main/tokenizers/list-item#readme
 [@yozora/tokenizer-math]:                     https://github.com/yozorajs/yozora/tree/main/tokenizers/math#readme
 [@yozora/tokenizer-paragraph]:                https://github.com/yozorajs/yozora/tree/main/tokenizers/paragraph#readme
 [@yozora/tokenizer-setext-heading]:           https://github.com/yozorajs/yozora/tree/main/tokenizers/setext-heading#readme
@@ -291,7 +290,6 @@ Name              | Type        | Required  | Default
 [doc-@yozora/tokenizer-definition]:           https://yozora.guanghechen.com/docs/package/tokenizer-definition
 [doc-@yozora/tokenizer-link-reference]:       https://yozora.guanghechen.com/docs/package/tokenizer-link-reference
 [doc-@yozora/tokenizer-list]:                 https://yozora.guanghechen.com/docs/package/tokenizer-list
-[doc-@yozora/tokenizer-list-item]:            https://yozora.guanghechen.com/docs/package/tokenizer-list-item
 [doc-@yozora/tokenizer-math]:                 https://yozora.guanghechen.com/docs/package/tokenizer-math
 [doc-@yozora/tokenizer-paragraph]:            https://yozora.guanghechen.com/docs/package/tokenizer-paragraph
 [doc-@yozora/tokenizer-setext-heading]:       https://yozora.guanghechen.com/docs/package/tokenizer-setext-heading

package/lib/cjs/index.js

@@ -5,20 +5,16 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var ast = require('@yozora/ast');
 var character = require('@yozora/character');
 var coreTokenizer = require('@yozora/core-tokenizer');
-var tokenizerImage = require('@yozora/tokenizer-image');
 var tokenizerLink = require('@yozora/tokenizer-link');
+var tokenizerImage = require('@yozora/tokenizer-image');
 
-const uniqueName = '@yozora/tokenizer-image-reference';
-
-class ImageReferenceTokenizer extends coreTokenizer.BaseInlineTokenizer {
-    constructor(props = {}) {
-        var _a, _b;
-        super({
-            name: (_a = props.name) !== null && _a !== void 0 ? _a : uniqueName,
-            priority: (_b = props.priority) !== null && _b !== void 0 ? _b : coreTokenizer.TokenizerPriority.LINKS,
-        });
-    }
-    _findDelimiter(startIndex, endIndex, api) {
+const match = function (api) {
+    return {
+        findDelimiter: () => coreTokenizer.genFindDelimiter(_findDelimiter),
+        isDelimiterPair,
+        processDelimiterPair,
+    };
+    function _findDelimiter(startIndex, endIndex) {
         const nodePoints = api.getNodePoints();
         for (let i = startIndex; i < endIndex; ++i) {
             const c = nodePoints[i].codePoint;
@@ -27,8 +23,7 @@ class ImageReferenceTokenizer extends coreTokenizer.BaseInlineTokenizer {
                     i += 1;
                     break;
                 case character.AsciiCodePoint.EXCLAMATION_MARK: {
-                    if (i + 1 >= endIndex ||
-                        nodePoints[i + 1].codePoint !== character.AsciiCodePoint.OPEN_BRACKET) {
+                    if (i + 1 >= endIndex || nodePoints[i + 1].codePoint !== character.AsciiCodePoint.OPEN_BRACKET) {
                         break;
                     }
                     return {
@@ -45,8 +40,7 @@ class ImageReferenceTokenizer extends coreTokenizer.BaseInlineTokenizer {
                         endIndex: i + 1,
                         brackets: [],
                     };
-                    if (i + 1 >= endIndex ||
-                        nodePoints[i + 1].codePoint !== character.AsciiCodePoint.OPEN_BRACKET) {
+                    if (i + 1 >= endIndex || nodePoints[i + 1].codePoint !== character.AsciiCodePoint.OPEN_BRACKET) {
                         return delimiter;
                     }
                     const result = coreTokenizer.eatLinkLabel(nodePoints, i + 1, endIndex);
@@ -83,7 +77,7 @@ class ImageReferenceTokenizer extends coreTokenizer.BaseInlineTokenizer {
         }
         return null;
     }
-    isDelimiterPair(openerDelimiter, closerDelimiter, internalTokens, api) {
+    function isDelimiterPair(openerDelimiter, closerDelimiter, internalTokens) {
         const nodePoints = api.getNodePoints();
         const balancedBracketsStatus = tokenizerLink.checkBalancedBracketsStatus(openerDelimiter.endIndex, closerDelimiter.startIndex, internalTokens, nodePoints);
         switch (balancedBracketsStatus) {
@@ -95,7 +89,7 @@ class ImageReferenceTokenizer extends coreTokenizer.BaseInlineTokenizer {
                 return { paired: false, opener: true, closer: false };
         }
     }
-    processDelimiterPair(openerDelimiter, closerDelimiter, internalTokens, api) {
+    function processDelimiterPair(openerDelimiter, closerDelimiter, internalTokens) {
         const nodePoints = api.getNodePoints();
         const bracket = closerDelimiter.brackets[0];
         if (bracket != null && bracket.identifier != null) {
@@ -130,20 +124,51 @@ class ImageReferenceTokenizer extends coreTokenizer.BaseInlineTokenizer {
         }
         return { tokens: internalTokens };
     }
-    parseInline(token, children) {
-        const { identifier, label, referenceType } = token;
-        const alt = tokenizerImage.calcImageAlt(children);
-        const result = {
-            type: ast.ImageReferenceType,
-            identifier,
-            label,
-            referenceType,
-            alt,
-        };
-        return result;
+};
+
+const parse = function (api) {
+    return {
+        parse: tokens => tokens.map(token => {
+            const { identifier, label, referenceType } = token;
+            const children = api.parseInlineTokens(token.children);
+            const alt = tokenizerImage.calcImageAlt(children);
+            const node = api.shouldReservePosition
+                ? {
+                    type: ast.ImageReferenceType,
+                    position: api.calcPosition(token),
+                    identifier,
+                    label,
+                    referenceType,
+                    alt,
+                }
+                : {
+                    type: ast.ImageReferenceType,
+                    identifier,
+                    label,
+                    referenceType,
+                    alt,
+                };
+            return node;
+        }),
+    };
+};
+
+const uniqueName = '@yozora/tokenizer-image-reference';
+
+class ImageReferenceTokenizer extends coreTokenizer.BaseInlineTokenizer {
+    constructor(props = {}) {
+        var _a, _b;
+        super({
+            name: (_a = props.name) !== null && _a !== void 0 ? _a : uniqueName,
+            priority: (_b = props.priority) !== null && _b !== void 0 ? _b : coreTokenizer.TokenizerPriority.LINKS,
+        });
+        this.match = match;
+        this.parse = parse;
     }
 }
 
 exports.ImageReferenceTokenizer = ImageReferenceTokenizer;
 exports.ImageReferenceTokenizerName = uniqueName;
-exports['default'] = ImageReferenceTokenizer;
+exports["default"] = ImageReferenceTokenizer;
+exports.imageReferenceMatch = match;
+exports.imageReferenceParse = parse;

package/lib/esm/index.js

@@ -1,20 +1,16 @@
 import { ImageReferenceType } from '@yozora/ast';
 import { AsciiCodePoint } from '@yozora/character';
-import { BaseInlineTokenizer, TokenizerPriority, eatLinkLabel } from '@yozora/core-tokenizer';
-import { calcImageAlt } from '@yozora/tokenizer-image';
+import { genFindDelimiter, eatLinkLabel, BaseInlineTokenizer, TokenizerPriority } from '@yozora/core-tokenizer';
 import { checkBalancedBracketsStatus } from '@yozora/tokenizer-link';
+import { calcImageAlt } from '@yozora/tokenizer-image';
 
-const uniqueName = '@yozora/tokenizer-image-reference';
-
-class ImageReferenceTokenizer extends BaseInlineTokenizer {
-    constructor(props = {}) {
-        var _a, _b;
-        super({
-            name: (_a = props.name) !== null && _a !== void 0 ? _a : uniqueName,
-            priority: (_b = props.priority) !== null && _b !== void 0 ? _b : TokenizerPriority.LINKS,
-        });
-    }
-    _findDelimiter(startIndex, endIndex, api) {
+const match = function (api) {
+    return {
+        findDelimiter: () => genFindDelimiter(_findDelimiter),
+        isDelimiterPair,
+        processDelimiterPair,
+    };
+    function _findDelimiter(startIndex, endIndex) {
         const nodePoints = api.getNodePoints();
         for (let i = startIndex; i < endIndex; ++i) {
             const c = nodePoints[i].codePoint;
@@ -23,8 +19,7 @@ class ImageReferenceTokenizer extends BaseInlineTokenizer {
                     i += 1;
                     break;
                 case AsciiCodePoint.EXCLAMATION_MARK: {
-                    if (i + 1 >= endIndex ||
-                        nodePoints[i + 1].codePoint !== AsciiCodePoint.OPEN_BRACKET) {
+                    if (i + 1 >= endIndex || nodePoints[i + 1].codePoint !== AsciiCodePoint.OPEN_BRACKET) {
                         break;
                     }
                     return {
@@ -41,8 +36,7 @@ class ImageReferenceTokenizer extends BaseInlineTokenizer {
                         endIndex: i + 1,
                         brackets: [],
                     };
-                    if (i + 1 >= endIndex ||
-                        nodePoints[i + 1].codePoint !== AsciiCodePoint.OPEN_BRACKET) {
+                    if (i + 1 >= endIndex || nodePoints[i + 1].codePoint !== AsciiCodePoint.OPEN_BRACKET) {
                         return delimiter;
                     }
                     const result = eatLinkLabel(nodePoints, i + 1, endIndex);
@@ -79,7 +73,7 @@ class ImageReferenceTokenizer extends BaseInlineTokenizer {
         }
         return null;
     }
-    isDelimiterPair(openerDelimiter, closerDelimiter, internalTokens, api) {
+    function isDelimiterPair(openerDelimiter, closerDelimiter, internalTokens) {
         const nodePoints = api.getNodePoints();
         const balancedBracketsStatus = checkBalancedBracketsStatus(openerDelimiter.endIndex, closerDelimiter.startIndex, internalTokens, nodePoints);
         switch (balancedBracketsStatus) {
@@ -91,7 +85,7 @@ class ImageReferenceTokenizer extends BaseInlineTokenizer {
                 return { paired: false, opener: true, closer: false };
         }
     }
-    processDelimiterPair(openerDelimiter, closerDelimiter, internalTokens, api) {
+    function processDelimiterPair(openerDelimiter, closerDelimiter, internalTokens) {
         const nodePoints = api.getNodePoints();
         const bracket = closerDelimiter.brackets[0];
         if (bracket != null && bracket.identifier != null) {
@@ -126,18 +120,47 @@ class ImageReferenceTokenizer extends BaseInlineTokenizer {
         }
         return { tokens: internalTokens };
     }
-    parseInline(token, children) {
-        const { identifier, label, referenceType } = token;
-        const alt = calcImageAlt(children);
-        const result = {
-            type: ImageReferenceType,
-            identifier,
-            label,
-            referenceType,
-            alt,
-        };
-        return result;
+};
+
+const parse = function (api) {
+    return {
+        parse: tokens => tokens.map(token => {
+            const { identifier, label, referenceType } = token;
+            const children = api.parseInlineTokens(token.children);
+            const alt = calcImageAlt(children);
+            const node = api.shouldReservePosition
+                ? {
+                    type: ImageReferenceType,
+                    position: api.calcPosition(token),
+                    identifier,
+                    label,
+                    referenceType,
+                    alt,
+                }
+                : {
+                    type: ImageReferenceType,
+                    identifier,
+                    label,
+                    referenceType,
+                    alt,
+                };
+            return node;
+        }),
+    };
+};
+
+const uniqueName = '@yozora/tokenizer-image-reference';
+
+class ImageReferenceTokenizer extends BaseInlineTokenizer {
+    constructor(props = {}) {
+        var _a, _b;
+        super({
+            name: (_a = props.name) !== null && _a !== void 0 ? _a : uniqueName,
+            priority: (_b = props.priority) !== null && _b !== void 0 ? _b : TokenizerPriority.LINKS,
+        });
+        this.match = match;
+        this.parse = parse;
     }
 }
 
-export { ImageReferenceTokenizer, uniqueName as ImageReferenceTokenizerName, ImageReferenceTokenizer as default };
+export { ImageReferenceTokenizer, uniqueName as ImageReferenceTokenizerName, ImageReferenceTokenizer as default, match as imageReferenceMatch, parse as imageReferenceParse };

package/lib/types/index.d.ts

@@ -1,5 +1,5 @@
-import { ImageReferenceTokenizer } from './tokenizer';
-export { ImageReferenceTokenizer } from './tokenizer';
+export { match as imageReferenceMatch } from './match';
+export { parse as imageReferenceParse } from './parse';
+export { ImageReferenceTokenizer, ImageReferenceTokenizer as default } from './tokenizer';
 export { uniqueName as ImageReferenceTokenizerName } from './types';
-export type { Token as ImageReferenceToken, TokenizerProps as ImageReferenceTokenizerProps, } from './types';
-export default ImageReferenceTokenizer;
+export type { IThis as IImageReferenceHookContext, IToken as IImageReferenceToken, ITokenizerProps as IImageReferenceTokenizerProps, } from './types';

package/lib/types/match.d.ts

@@ -0,0 +1,33 @@
+import type { IMatchInlineHookCreator } from '@yozora/core-tokenizer';
+import type { IDelimiter, IThis, IToken, T } from './types';
+/**
+ * Syntax for image-references is like the syntax for link-references, with one
+ * difference. Instead of link text, we have an image description. The rules for
+ * this are the same as for link text, except that
+ *
+ *  a) an image description starts with '![' rather than '[', and
+ *  b) an image description may contain links.
+ *
+ * An image description has inline elements as its contents. When an image is
+ * rendered to HTML, this is standardly used as the image’s alt attribute.
+ *
+ * One type of opener delimiter: '!['
+ *
+ * Three types of closer delimiter: ']', '][]' something like '][bar]'
+ *
+ * ------
+ *
+ * A 'opener' type delimiter is one of the following forms:
+ *
+ *  - '!['
+ *
+ * A 'closer' type delimiter is one of the following forms:
+ *
+ *  - ']'
+ *  - '][]'
+ *  - '][identifier]'
+ *
+ * @see https://github.com/syntax-tree/mdast#imagereference
+ * @see https://github.github.com/gfm/#images
+ */
+export declare const match: IMatchInlineHookCreator<T, IDelimiter, IToken, IThis>;

package/lib/types/parse.d.ts

@@ -0,0 +1,3 @@
+import type { IParseInlineHookCreator } from '@yozora/core-tokenizer';
+import type { INode, IThis, IToken, T } from './types';
+export declare const parse: IParseInlineHookCreator<T, IToken, INode, IThis>;

package/lib/types/tokenizer.d.ts

@@ -1,59 +1,13 @@
-import type { YastNode } from '@yozora/ast';
-import type { MatchInlinePhaseApi, ResultOfIsDelimiterPair, ResultOfProcessDelimiterPair, Tokenizer, TokenizerMatchInlineHook, TokenizerParseInlineHook, YastInlineToken } from '@yozora/core-tokenizer';
+import type { IInlineTokenizer, IMatchInlineHookCreator, IParseInlineHookCreator } from '@yozora/core-tokenizer';
 import { BaseInlineTokenizer } from '@yozora/core-tokenizer';
-import type { Delimiter, Node, T, Token, TokenizerProps } from './types';
+import type { IDelimiter, INode, IThis, IToken, ITokenizerProps, T } from './types';
 /**
  * Lexical Analyzer for ImageReference.
- *
- * Syntax for image-references is like the syntax for link-references, with one
- * difference. Instead of link text, we have an image description. The rules for
- * this are the same as for link text, except that
- *
- *  a) an image description starts with '![' rather than '[', and
- *  b) an image description may contain links.
- *
- * An image description has inline elements as its contents. When an image is
- * rendered to HTML, this is standardly used as the image’s alt attribute.
- *
- * One type of opener delimiter: '!['
- *
- * Three types of closer delimiter: ']', '][]' something like '][bar]'
- *
- * ------
- *
- * A 'opener' type delimiter is one of the following forms:
- *
- *  - '!['
- *
- * A 'closer' type delimiter is one of the following forms:
- *
- *  - ']'
- *  - '][]'
- *  - '][identifier]'
- *
  * @see https://github.com/syntax-tree/mdast#imagereference
  * @see https://github.github.com/gfm/#images
  */
-export declare class ImageReferenceTokenizer extends BaseInlineTokenizer<Delimiter> implements Tokenizer, TokenizerMatchInlineHook<T, Delimiter, Token>, TokenizerParseInlineHook<T, Token, Node> {
-    constructor(props?: TokenizerProps);
-    /**
-     * @override
-     * @see BaseInlineTokenizer
-     */
-    protected _findDelimiter(startIndex: number, endIndex: number, api: Readonly<MatchInlinePhaseApi>): Delimiter | null;
-    /**
-     * @override
-     * @see TokenizerMatchInlineHook
-     */
-    isDelimiterPair(openerDelimiter: Delimiter, closerDelimiter: Delimiter, internalTokens: ReadonlyArray<YastInlineToken>, api: Readonly<MatchInlinePhaseApi>): ResultOfIsDelimiterPair;
-    /**
-     * @override
-     * @see TokenizerMatchInlineHook
-     */
-    processDelimiterPair(openerDelimiter: Delimiter, closerDelimiter: Delimiter, internalTokens: ReadonlyArray<YastInlineToken>, api: Readonly<MatchInlinePhaseApi>): ResultOfProcessDelimiterPair<T, Token, Delimiter>;
-    /**
-     * @override
-     * @see TokenizerParseInlineHook
-     */
-    parseInline(token: Token, children: YastNode[]): Node;
+export declare class ImageReferenceTokenizer extends BaseInlineTokenizer<T, IDelimiter, IToken, INode, IThis> implements IInlineTokenizer<T, IDelimiter, IToken, INode, IThis> {
+    constructor(props?: ITokenizerProps);
+    readonly match: IMatchInlineHookCreator<T, IDelimiter, IToken, IThis>;
+    readonly parse: IParseInlineHookCreator<T, IToken, INode, IThis>;
 }

package/lib/types/types.d.ts

@@ -1,12 +1,13 @@
-import type { ImageReference, ImageReferenceType, YastAssociation, YastReference } from '@yozora/ast';
-import type { BaseInlineTokenizerProps, PartialYastInlineToken, YastTokenDelimiter } from '@yozora/core-tokenizer';
-import type { LinkReferenceDelimiterBracket } from '@yozora/tokenizer-link-reference';
+import type { Association, ImageReference, ImageReferenceType, Reference } from '@yozora/ast';
+import type { IBaseInlineTokenizerProps, IPartialYastInlineToken, ITokenizer, IYastTokenDelimiter } from '@yozora/core-tokenizer';
+import type { ILinkReferenceDelimiterBracket } from '@yozora/tokenizer-link-reference';
 export declare const uniqueName = "@yozora/tokenizer-image-reference";
 export declare type T = ImageReferenceType;
-export declare type Node = ImageReference;
-export interface Token extends PartialYastInlineToken<T>, YastAssociation, YastReference {
+export declare type INode = ImageReference;
+export interface IToken extends IPartialYastInlineToken<T>, Association, Reference {
 }
-export interface Delimiter extends YastTokenDelimiter {
-    brackets: LinkReferenceDelimiterBracket[];
+export interface IDelimiter extends IYastTokenDelimiter {
+    brackets: ILinkReferenceDelimiterBracket[];
 }
-export declare type TokenizerProps = Partial<BaseInlineTokenizerProps>;
+export declare type IThis = ITokenizer;
+export declare type ITokenizerProps = Partial<IBaseInlineTokenizerProps>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yozora/tokenizer-image-reference",
-  "version": "1.3.0",
+  "version": "2.0.0-alpha.3",
   "author": {
     "name": "guanghechen",
     "url": "https://github.com/guanghechen/"
@@ -35,11 +35,11 @@
     "test": "cross-env TS_NODE_FILES=true jest --config ../../jest.config.js --rootDir ."
   },
   "dependencies": {
-    "@yozora/ast": "^1.3.0",
-    "@yozora/character": "^1.3.0",
-    "@yozora/core-tokenizer": "^1.3.0",
-    "@yozora/tokenizer-image": "^1.3.0",
-    "@yozora/tokenizer-link": "^1.3.0"
+    "@yozora/ast": "^2.0.0-alpha.3",
+    "@yozora/character": "^2.0.0-alpha.3",
+    "@yozora/core-tokenizer": "^2.0.0-alpha.3",
+    "@yozora/tokenizer-image": "^2.0.0-alpha.3",
+    "@yozora/tokenizer-link": "^2.0.0-alpha.3"
   },
-  "gitHead": "18c9b167004ad97718b2f94f25139f80598cbf7a"
+  "gitHead": "9f274fc7487a8c1dd213405d92508f9a7621f730"
 }