@yozora/tokenizer-footnote 1.2.2 → 2.0.0-alpha.2

package/README.md

@@ -84,14 +84,14 @@ so you can use `YozoraParser` 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 FootnoteTokenizer from '@yozora/tokenizer-footnote'
 
-const parser = new DefaultYastParser()
-  .useBlockFallbackTokenizer(new ParagraphTokenizer())
-  .useInlineFallbackTokenizer(new TextTokenizer())
+const parser = new DefaultParser()
+  .useFallbackTokenizer(new ParagraphTokenizer())
+  .useFallbackTokenizer(new TextTokenizer())
   .useTokenizer(new FootnoteTokenizer())
 
 // parse source markdown content
@@ -234,7 +234,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
@@ -294,7 +293,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

@@ -7,17 +7,14 @@ var character = require('@yozora/character');
 var coreTokenizer = require('@yozora/core-tokenizer');
 var tokenizerLink = require('@yozora/tokenizer-link');
 
-const uniqueName = '@yozora/tokenizer-footnote';
-
-class FootnoteTokenizer 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, nodePoints) {
+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;
             switch (c) {
@@ -25,8 +22,7 @@ class FootnoteTokenizer extends coreTokenizer.BaseInlineTokenizer {
                     i += 1;
                     break;
                 case character.AsciiCodePoint.CARET: {
-                    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 {
                             type: 'opener',
                             startIndex: i,
@@ -45,7 +41,8 @@ class FootnoteTokenizer extends coreTokenizer.BaseInlineTokenizer {
         }
         return null;
     }
-    isDelimiterPair(openerDelimiter, closerDelimiter, internalTokens, nodePoints) {
+    function isDelimiterPair(openerDelimiter, closerDelimiter, internalTokens) {
+        const nodePoints = api.getNodePoints();
         const balancedBracketsStatus = tokenizerLink.checkBalancedBracketsStatus(openerDelimiter.endIndex, closerDelimiter.startIndex, internalTokens, nodePoints);
         switch (balancedBracketsStatus) {
             case -1:
@@ -56,24 +53,45 @@ class FootnoteTokenizer extends coreTokenizer.BaseInlineTokenizer {
                 return { paired: false, opener: true, closer: false };
         }
     }
-    processDelimiterPair(openerDelimiter, closerDelimiter, internalTokens, nodePoints, api) {
+    function processDelimiterPair(openerDelimiter, closerDelimiter, internalTokens) {
         const token = {
             nodeType: ast.FootnoteType,
             startIndex: openerDelimiter.startIndex,
             endIndex: closerDelimiter.endIndex,
-            children: api.resolveInternalTokens(internalTokens, openerDelimiter.endIndex, closerDelimiter.startIndex, nodePoints),
+            children: api.resolveInternalTokens(internalTokens, openerDelimiter.endIndex, closerDelimiter.startIndex),
         };
         return { tokens: [token] };
     }
-    processToken(token, children) {
-        const result = {
-            type: ast.FootnoteType,
-            children: children || [],
-        };
-        return result;
+};
+
+const parse = function (api) {
+    return {
+        parse: tokens => tokens.map(token => {
+            const children = api.parseInlineTokens(token.children);
+            const node = api.shouldReservePosition
+                ? { type: ast.FootnoteType, position: api.calcPosition(token), children }
+                : { type: ast.FootnoteType, children };
+            return node;
+        }),
+    };
+};
+
+const uniqueName = '@yozora/tokenizer-footnote';
+
+class FootnoteTokenizer 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.FootnoteTokenizer = FootnoteTokenizer;
 exports.FootnoteTokenizerName = uniqueName;
-exports['default'] = FootnoteTokenizer;
+exports["default"] = FootnoteTokenizer;
+exports.footnoteMatch = match;
+exports.footnoteParse = parse;

package/lib/esm/index.js

@@ -1,19 +1,16 @@
 import { FootnoteType } from '@yozora/ast';
 import { AsciiCodePoint } from '@yozora/character';
-import { BaseInlineTokenizer, TokenizerPriority } from '@yozora/core-tokenizer';
+import { genFindDelimiter, BaseInlineTokenizer, TokenizerPriority } from '@yozora/core-tokenizer';
 import { checkBalancedBracketsStatus } from '@yozora/tokenizer-link';
 
-const uniqueName = '@yozora/tokenizer-footnote';
-
-class FootnoteTokenizer 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, nodePoints) {
+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;
             switch (c) {
@@ -21,8 +18,7 @@ class FootnoteTokenizer extends BaseInlineTokenizer {
                     i += 1;
                     break;
                 case AsciiCodePoint.CARET: {
-                    if (i + 1 < endIndex &&
-                        nodePoints[i + 1].codePoint === AsciiCodePoint.OPEN_BRACKET) {
+                    if (i + 1 < endIndex && nodePoints[i + 1].codePoint === AsciiCodePoint.OPEN_BRACKET) {
                         return {
                             type: 'opener',
                             startIndex: i,
@@ -41,7 +37,8 @@ class FootnoteTokenizer extends BaseInlineTokenizer {
         }
         return null;
     }
-    isDelimiterPair(openerDelimiter, closerDelimiter, internalTokens, nodePoints) {
+    function isDelimiterPair(openerDelimiter, closerDelimiter, internalTokens) {
+        const nodePoints = api.getNodePoints();
         const balancedBracketsStatus = checkBalancedBracketsStatus(openerDelimiter.endIndex, closerDelimiter.startIndex, internalTokens, nodePoints);
         switch (balancedBracketsStatus) {
             case -1:
@@ -52,22 +49,41 @@ class FootnoteTokenizer extends BaseInlineTokenizer {
                 return { paired: false, opener: true, closer: false };
         }
     }
-    processDelimiterPair(openerDelimiter, closerDelimiter, internalTokens, nodePoints, api) {
+    function processDelimiterPair(openerDelimiter, closerDelimiter, internalTokens) {
         const token = {
             nodeType: FootnoteType,
             startIndex: openerDelimiter.startIndex,
             endIndex: closerDelimiter.endIndex,
-            children: api.resolveInternalTokens(internalTokens, openerDelimiter.endIndex, closerDelimiter.startIndex, nodePoints),
+            children: api.resolveInternalTokens(internalTokens, openerDelimiter.endIndex, closerDelimiter.startIndex),
         };
         return { tokens: [token] };
     }
-    processToken(token, children) {
-        const result = {
-            type: FootnoteType,
-            children: children || [],
-        };
-        return result;
+};
+
+const parse = function (api) {
+    return {
+        parse: tokens => tokens.map(token => {
+            const children = api.parseInlineTokens(token.children);
+            const node = api.shouldReservePosition
+                ? { type: FootnoteType, position: api.calcPosition(token), children }
+                : { type: FootnoteType, children };
+            return node;
+        }),
+    };
+};
+
+const uniqueName = '@yozora/tokenizer-footnote';
+
+class FootnoteTokenizer 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 { FootnoteTokenizer, uniqueName as FootnoteTokenizerName, FootnoteTokenizer as default };
+export { FootnoteTokenizer, uniqueName as FootnoteTokenizerName, FootnoteTokenizer as default, match as footnoteMatch, parse as footnoteParse };

package/lib/types/index.d.ts

@@ -1,5 +1,5 @@
-import { FootnoteTokenizer } from './tokenizer';
-export { FootnoteTokenizer } from './tokenizer';
+export { match as footnoteMatch } from './match';
+export { parse as footnoteParse } from './parse';
+export { FootnoteTokenizer, FootnoteTokenizer as default } from './tokenizer';
 export { uniqueName as FootnoteTokenizerName } from './types';
-export type { Token as FootnoteToken, TokenizerProps as FootnoteTokenizerProps, } from './types';
-export default FootnoteTokenizer;
+export type { IThis as IFootnoteHookContext, IToken as IFootnoteToken, ITokenizerProps as IFootnoteTokenizerProps, } from './types';

package/lib/types/match.d.ts

@@ -0,0 +1,15 @@
+import type { IMatchInlineHookCreator } from '@yozora/core-tokenizer';
+import type { IDelimiter, IThis, IToken, T } from './types';
+/**
+ * An inline footnote consists of a footnote text followed immediately by a right
+ * square bracket ']'.
+ *
+ * Like the inline links, footnote could not be contained by other footnote.
+ *
+ * @see https://github.com/syntax-tree/mdast-util-footnote
+ * @see https://github.com/remarkjs/remark-footnotes
+ * @see https://github.com/syntax-tree/mdast#link
+ * @see https://github.github.com/gfm/#links
+ * @see https://www.markdownguide.org/extended-syntax/#footnotes
+ */
+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,42 +1,16 @@
-import type { YastNode } from '@yozora/ast';
-import type { NodePoint } from '@yozora/character';
-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 inline footnote.
- *
- * An inline footnote consists of a footnote text followed immediately by a right
- * square bracket ']'.
- *
- * Like the inline links, footnote could not be contained by other footnote.
- *
  * @see https://github.com/syntax-tree/mdast-util-footnote
  * @see https://github.com/remarkjs/remark-footnotes
  * @see https://github.com/syntax-tree/mdast#link
  * @see https://github.github.com/gfm/#links
  * @see https://www.markdownguide.org/extended-syntax/#footnotes
  */
-export declare class FootnoteTokenizer 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, nodePoints: ReadonlyArray<NodePoint>): Delimiter | null;
-    /**
-     * @override
-     * @see TokenizerMatchInlineHook
-     */
-    isDelimiterPair(openerDelimiter: Delimiter, closerDelimiter: Delimiter, internalTokens: ReadonlyArray<YastInlineToken>, nodePoints: ReadonlyArray<NodePoint>): ResultOfIsDelimiterPair;
-    /**
-     * @override
-     * @see TokenizerMatchInlineHook
-     */
-    processDelimiterPair(openerDelimiter: Delimiter, closerDelimiter: Delimiter, internalTokens: ReadonlyArray<YastInlineToken>, nodePoints: ReadonlyArray<NodePoint>, api: Readonly<MatchInlinePhaseApi>): ResultOfProcessDelimiterPair<T, Token, Delimiter>;
-    /**
-     * @override
-     * @see TokenizerParseInlineHook
-     */
-    processToken(token: Token, children: YastNode[] | undefined): Node;
+export declare class FootnoteTokenizer 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,13 +1,14 @@
-import type { Footnote, FootnoteType } from '@yozora/ast';
-import type { BaseInlineTokenizerProps, PartialYastInlineToken, YastTokenDelimiter } from '@yozora/core-tokenizer';
+import type { FootnoteType, IFootnote } from '@yozora/ast';
+import type { IBaseInlineTokenizerProps, IPartialYastInlineToken, ITokenizer, IYastTokenDelimiter } from '@yozora/core-tokenizer';
 export declare type T = FootnoteType;
-export declare type Node = Footnote;
+export declare type INode = IFootnote;
 export declare const uniqueName = "@yozora/tokenizer-footnote";
-export declare type Token = PartialYastInlineToken<T>;
-export interface Delimiter extends YastTokenDelimiter {
+export declare type IToken = IPartialYastInlineToken<T>;
+export interface IDelimiter extends IYastTokenDelimiter {
     /**
-     * Delimiter type.
+     * IDelimiter type.
      */
     type: 'opener' | 'closer';
 }
-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-footnote",
-  "version": "1.2.2",
+  "version": "2.0.0-alpha.2",
   "author": {
     "name": "guanghechen",
     "url": "https://github.com/guanghechen/"
@@ -35,10 +35,10 @@
     "test": "cross-env TS_NODE_FILES=true jest --config ../../jest.config.js --rootDir ."
   },
   "dependencies": {
-    "@yozora/ast": "^1.2.2",
-    "@yozora/character": "^1.2.2",
-    "@yozora/core-tokenizer": "^1.2.2",
-    "@yozora/tokenizer-link": "^1.2.2"
+    "@yozora/ast": "^2.0.0-alpha.2",
+    "@yozora/character": "^2.0.0-alpha.2",
+    "@yozora/core-tokenizer": "^2.0.0-alpha.2",
+    "@yozora/tokenizer-link": "^2.0.0-alpha.2"
   },
-  "gitHead": "fb4b804548592c09259aabcf9cc4dd96176bd024"
+  "gitHead": "da59d85520455c59a117a35032ef1a035c10ea21"
 }