@yozora/tokenizer-footnote-definition 1.3.0 → 2.0.0-alpha.3

package/README.md

@@ -83,14 +83,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 FootnoteDefinitionTokenizer from '@yozora/tokenizer-footnote-definition'
 
-const parser = new DefaultYastParser()
-  .useBlockFallbackTokenizer(new ParagraphTokenizer())
-  .useInlineFallbackTokenizer(new TextTokenizer())
+const parser = new DefaultParser()
+  .useFallbackTokenizer(new ParagraphTokenizer())
+  .useFallbackTokenizer(new TextTokenizer())
   .useTokenizer(new FootnoteDefinitionTokenizer())
 
 // parse source markdown content
@@ -278,7 +278,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
@@ -338,7 +337,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

@@ -2,12 +2,10 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var ast = require('@yozora/ast');
 var character = require('@yozora/character');
+var ast = require('@yozora/ast');
 var coreTokenizer = require('@yozora/core-tokenizer');
 
-const uniqueName = '@yozora/tokenizer-footnote-definition';
-
 function eatFootnoteLabel(nodePoints, firstNonWhitespaceIndex, endIndex) {
     let i = firstNonWhitespaceIndex;
     if (i + 1 >= endIndex ||
@@ -38,17 +36,15 @@ function eatFootnoteLabel(nodePoints, firstNonWhitespaceIndex, endIndex) {
     return -1;
 }
 
-class FootnoteDefinitionTokenizer extends coreTokenizer.BaseBlockTokenizer {
-    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.CONTAINING_BLOCK,
-        });
-        this.isContainingBlock = true;
-        this.indent = 4;
-    }
-    eatOpener(line) {
+const match = function (api) {
+    const { indent } = this;
+    return {
+        isContainingBlock: true,
+        eatOpener,
+        eatContinuationText,
+        onClose,
+    };
+    function eatOpener(line) {
         if (line.countOfPrecedeSpaces >= 4)
             return null;
         const { nodePoints, startIndex, firstNonWhitespaceIndex, endIndex } = line;
@@ -73,40 +69,71 @@ class FootnoteDefinitionTokenizer extends coreTokenizer.BaseBlockTokenizer {
         };
         return { token, nextIndex: nextIndex + 1 };
     }
-    eatContinuationText(line) {
-        const { startIndex, endIndex, firstNonWhitespaceIndex, countOfPrecedeSpaces, } = line;
+    function eatContinuationText(line) {
+        const { startIndex, endIndex, firstNonWhitespaceIndex, countOfPrecedeSpaces } = line;
         if (firstNonWhitespaceIndex >= endIndex) {
             return {
                 status: 'opening',
-                nextIndex: Math.min(endIndex - 1, startIndex + this.indent),
+                nextIndex: Math.min(endIndex - 1, startIndex + indent),
             };
         }
-        if (countOfPrecedeSpaces >= this.indent) {
-            return { status: 'opening', nextIndex: startIndex + this.indent };
+        if (countOfPrecedeSpaces >= indent) {
+            return { status: 'opening', nextIndex: startIndex + indent };
         }
         return { status: 'notMatched' };
     }
-    onClose(token, api) {
+    function onClose(token) {
         const label = character.calcStringFromNodePoints(token.label.nodePoints, token.label.startIndex + 2, token.label.endIndex - 1);
         const identifier = coreTokenizer.resolveLabelToIdentifier(label);
         api.registerFootnoteDefinitionIdentifier(identifier);
         token._label = label;
         token._identifier = identifier;
     }
-    parseBlock(token, children) {
-        const label = token._label;
-        const identifier = token._identifier;
-        const node = {
-            type: ast.FootnoteDefinitionType,
-            identifier,
-            label,
-            children,
-        };
-        return node;
+};
+
+const parse = function (api) {
+    return {
+        parse: tokens => tokens.map(token => {
+            const label = token._label;
+            const identifier = token._identifier;
+            const children = api.parseBlockTokens(token.children);
+            const node = api.shouldReservePosition
+                ? {
+                    type: ast.FootnoteDefinitionType,
+                    position: token.position,
+                    identifier,
+                    label,
+                    children,
+                }
+                : {
+                    type: ast.FootnoteDefinitionType,
+                    identifier,
+                    label,
+                    children,
+                };
+            return node;
+        }),
+    };
+};
+
+const uniqueName = '@yozora/tokenizer-footnote-definition';
+
+class FootnoteDefinitionTokenizer extends coreTokenizer.BaseBlockTokenizer {
+    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.CONTAINING_BLOCK,
+        });
+        this.indent = 4;
+        this.match = match;
+        this.parse = parse;
     }
 }
 
 exports.FootnoteDefinitionTokenizer = FootnoteDefinitionTokenizer;
 exports.FootnoteDefinitionTokenizerName = uniqueName;
-exports['default'] = FootnoteDefinitionTokenizer;
+exports["default"] = FootnoteDefinitionTokenizer;
 exports.eatFootnoteLabel = eatFootnoteLabel;
+exports.footnoteDefinitionMatch = match;
+exports.footnoteDefinitionParse = parse;

package/lib/esm/index.js

@@ -1,8 +1,6 @@
-import { FootnoteDefinitionType } from '@yozora/ast';
 import { AsciiCodePoint, isWhitespaceCharacter, VirtualCodePoint, calcStringFromNodePoints } from '@yozora/character';
-import { BaseBlockTokenizer, TokenizerPriority, calcStartYastNodePoint, calcEndYastNodePoint, resolveLabelToIdentifier } from '@yozora/core-tokenizer';
-
-const uniqueName = '@yozora/tokenizer-footnote-definition';
+import { FootnoteDefinitionType } from '@yozora/ast';
+import { calcStartYastNodePoint, calcEndYastNodePoint, resolveLabelToIdentifier, BaseBlockTokenizer, TokenizerPriority } from '@yozora/core-tokenizer';
 
 function eatFootnoteLabel(nodePoints, firstNonWhitespaceIndex, endIndex) {
     let i = firstNonWhitespaceIndex;
@@ -34,17 +32,15 @@ function eatFootnoteLabel(nodePoints, firstNonWhitespaceIndex, endIndex) {
     return -1;
 }
 
-class FootnoteDefinitionTokenizer extends BaseBlockTokenizer {
-    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.CONTAINING_BLOCK,
-        });
-        this.isContainingBlock = true;
-        this.indent = 4;
-    }
-    eatOpener(line) {
+const match = function (api) {
+    const { indent } = this;
+    return {
+        isContainingBlock: true,
+        eatOpener,
+        eatContinuationText,
+        onClose,
+    };
+    function eatOpener(line) {
         if (line.countOfPrecedeSpaces >= 4)
             return null;
         const { nodePoints, startIndex, firstNonWhitespaceIndex, endIndex } = line;
@@ -69,37 +65,66 @@ class FootnoteDefinitionTokenizer extends BaseBlockTokenizer {
         };
         return { token, nextIndex: nextIndex + 1 };
     }
-    eatContinuationText(line) {
-        const { startIndex, endIndex, firstNonWhitespaceIndex, countOfPrecedeSpaces, } = line;
+    function eatContinuationText(line) {
+        const { startIndex, endIndex, firstNonWhitespaceIndex, countOfPrecedeSpaces } = line;
         if (firstNonWhitespaceIndex >= endIndex) {
             return {
                 status: 'opening',
-                nextIndex: Math.min(endIndex - 1, startIndex + this.indent),
+                nextIndex: Math.min(endIndex - 1, startIndex + indent),
             };
         }
-        if (countOfPrecedeSpaces >= this.indent) {
-            return { status: 'opening', nextIndex: startIndex + this.indent };
+        if (countOfPrecedeSpaces >= indent) {
+            return { status: 'opening', nextIndex: startIndex + indent };
         }
         return { status: 'notMatched' };
     }
-    onClose(token, api) {
+    function onClose(token) {
         const label = calcStringFromNodePoints(token.label.nodePoints, token.label.startIndex + 2, token.label.endIndex - 1);
         const identifier = resolveLabelToIdentifier(label);
         api.registerFootnoteDefinitionIdentifier(identifier);
         token._label = label;
         token._identifier = identifier;
     }
-    parseBlock(token, children) {
-        const label = token._label;
-        const identifier = token._identifier;
-        const node = {
-            type: FootnoteDefinitionType,
-            identifier,
-            label,
-            children,
-        };
-        return node;
+};
+
+const parse = function (api) {
+    return {
+        parse: tokens => tokens.map(token => {
+            const label = token._label;
+            const identifier = token._identifier;
+            const children = api.parseBlockTokens(token.children);
+            const node = api.shouldReservePosition
+                ? {
+                    type: FootnoteDefinitionType,
+                    position: token.position,
+                    identifier,
+                    label,
+                    children,
+                }
+                : {
+                    type: FootnoteDefinitionType,
+                    identifier,
+                    label,
+                    children,
+                };
+            return node;
+        }),
+    };
+};
+
+const uniqueName = '@yozora/tokenizer-footnote-definition';
+
+class FootnoteDefinitionTokenizer extends BaseBlockTokenizer {
+    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.CONTAINING_BLOCK,
+        });
+        this.indent = 4;
+        this.match = match;
+        this.parse = parse;
     }
 }
 
-export { FootnoteDefinitionTokenizer, uniqueName as FootnoteDefinitionTokenizerName, FootnoteDefinitionTokenizer as default, eatFootnoteLabel };
+export { FootnoteDefinitionTokenizer, uniqueName as FootnoteDefinitionTokenizerName, FootnoteDefinitionTokenizer as default, eatFootnoteLabel, match as footnoteDefinitionMatch, parse as footnoteDefinitionParse };

package/lib/types/index.d.ts

@@ -1,6 +1,6 @@
-import { FootnoteDefinitionTokenizer } from './tokenizer';
 export * from './util';
-export { FootnoteDefinitionTokenizer } from './tokenizer';
+export { match as footnoteDefinitionMatch } from './match';
+export { parse as footnoteDefinitionParse } from './parse';
+export { FootnoteDefinitionTokenizer, FootnoteDefinitionTokenizer as default } from './tokenizer';
 export { uniqueName as FootnoteDefinitionTokenizerName } from './types';
-export type { Token as FootnoteDefinitionToken, TokenizerProps as FootnoteDefinitionTokenizerProps, } from './types';
-export default FootnoteDefinitionTokenizer;
+export type { IThis as IFootnoteDefinitionHookContext, IToken as IFootnoteDefinitionToken, ITokenizerProps as IFootnoteDefinitionTokenizerProps, } from './types';

package/lib/types/match.d.ts

@@ -0,0 +1,22 @@
+import type { IMatchBlockHookCreator } from '@yozora/core-tokenizer';
+import type { IThis, IToken, T } from './types';
+/**
+ * A footnote reference definition consists of a footnote label, indented up
+ * to three spaces, followed by a colon (:), optional whitespace (including up
+ * to one line ending), a footnote contents consisted by paragraph-like strings.
+ *
+ * Unlike the link label, the footnote label should be on the same line and it
+ * begins with a left bracket ([) followed by a caret (^), and ends with the
+ * first right bracket (]) that is not backslash-escaped. Between the caret of
+ * right bracket, there must be at least one non-whitespace character.
+ * Unescaped square bracket characters are not allowed inside the opening creat
+ * and closing square bracket of footnote labels. A footnote label can have at
+ * most 999 characters inside the caret and right bracket.
+ *
+ * @see https://github.github.com/gfm/#link-label
+ * @see https://github.github.com/gfm/#link-reference-definition
+ * @see https://github.com/syntax-tree/mdast-util-footnote
+ * @see https://github.com/remarkjs/remark-footnotes
+ * @see https://www.markdownguide.org/extended-syntax/#footnotes
+ */
+export declare const match: IMatchBlockHookCreator<T, IToken, IThis>;

package/lib/types/parse.d.ts

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

package/lib/types/tokenizer.d.ts

@@ -1,50 +1,17 @@
-import type { YastNode } from '@yozora/ast';
-import type { MatchBlockPhaseApi, PhrasingContentLine, ResultOfEatContinuationText, ResultOfEatOpener, ResultOfOnClose, ResultOfParse, Tokenizer, TokenizerMatchBlockHook, TokenizerParseBlockHook } from '@yozora/core-tokenizer';
+import type { IBlockTokenizer, IMatchBlockHookCreator, IParseBlockHookCreator } from '@yozora/core-tokenizer';
 import { BaseBlockTokenizer } from '@yozora/core-tokenizer';
-import type { Node, T, Token, TokenizerProps } from './types';
+import type { INode, IThis, IToken, ITokenizerProps, T } from './types';
 /**
  * Lexical Analyzer for FootnoteDefinition.
- *
- * A footnote reference definition consists of a footnote label, indented up
- * to three spaces, followed by a colon (:), optional whitespace (including up
- * to one line ending), a footnote contents consisted by paragraph-like strings.
- *
- * Unlike the link label, the footnote label should be on the same line and it
- * begins with a left bracket ([) followed by a caret (^), and ends with the
- * first right bracket (]) that is not backslash-escaped. Between the caret of
- * right bracket, there must be at least one non-whitespace character.
- * Unescaped square bracket characters are not allowed inside the opening creat
- * and closing square bracket of footnote labels. A footnote label can have at
- * most 999 characters inside the caret and right bracket.
- *
  * @see https://github.github.com/gfm/#link-label
  * @see https://github.github.com/gfm/#link-reference-definition
  * @see https://github.com/syntax-tree/mdast-util-footnote
  * @see https://github.com/remarkjs/remark-footnotes
  * @see https://www.markdownguide.org/extended-syntax/#footnotes
  */
-export declare class FootnoteDefinitionTokenizer extends BaseBlockTokenizer implements Tokenizer, TokenizerMatchBlockHook<T, Token>, TokenizerParseBlockHook<T, Token, Node> {
-    readonly isContainingBlock = true;
+export declare class FootnoteDefinitionTokenizer extends BaseBlockTokenizer<T, IToken, INode, IThis> implements IBlockTokenizer<T, IToken, INode, IThis> {
+    constructor(props?: ITokenizerProps);
     readonly indent = 4;
-    constructor(props?: TokenizerProps);
-    /**
-     * @override
-     * @see TokenizerMatchBlockHook
-     */
-    eatOpener(line: Readonly<PhrasingContentLine>): ResultOfEatOpener<T, Token>;
-    /**
-     * @override
-     * @see TokenizerMatchBlockHook
-     */
-    eatContinuationText(line: Readonly<PhrasingContentLine>): ResultOfEatContinuationText;
-    /**
-     * @override
-     * @see TokenizerMatchBlockHook
-     */
-    onClose(token: Token, api: Readonly<MatchBlockPhaseApi>): ResultOfOnClose;
-    /**
-     * @override
-     * @see TokenizerParseBlockHook
-     */
-    parseBlock(token: Readonly<Token>, children: YastNode[]): ResultOfParse<T, Node>;
+    readonly match: IMatchBlockHookCreator<T, IToken, IThis>;
+    readonly parse: IParseBlockHookCreator<T, IToken, INode, IThis>;
 }

package/lib/types/types.d.ts

@@ -1,20 +1,20 @@
 import type { FootnoteDefinition, FootnoteDefinitionType } from '@yozora/ast';
-import type { NodeInterval, NodePoint } from '@yozora/character';
-import type { BaseBlockTokenizerProps, PartialYastBlockToken, YastBlockToken } from '@yozora/core-tokenizer';
+import type { INodeInterval, INodePoint } from '@yozora/character';
+import type { IBaseBlockTokenizerProps, IPartialYastBlockToken, ITokenizer, IYastBlockToken } from '@yozora/core-tokenizer';
 export declare type T = FootnoteDefinitionType;
-export declare type Node = FootnoteDefinition;
+export declare type INode = FootnoteDefinition;
 export declare const uniqueName = "@yozora/tokenizer-footnote-definition";
-export interface Token extends PartialYastBlockToken<T> {
+export interface IToken extends IPartialYastBlockToken<T> {
     /**
      * Footnote label
      */
-    label: NodeInterval & {
-        nodePoints: ReadonlyArray<NodePoint>;
+    label: INodeInterval & {
+        nodePoints: ReadonlyArray<INodePoint>;
     };
     /**
      *
      */
-    children: YastBlockToken[];
+    children: IYastBlockToken[];
     /**
      * Resolved definition label.
      */
@@ -24,4 +24,7 @@ export interface Token extends PartialYastBlockToken<T> {
      */
     _identifier?: string;
 }
-export declare type TokenizerProps = Partial<BaseBlockTokenizerProps>;
+export interface IThis extends ITokenizer {
+    indent: number;
+}
+export declare type ITokenizerProps = Partial<IBaseBlockTokenizerProps>;

package/lib/types/util.d.ts

@@ -1,4 +1,4 @@
-import type { NodePoint } from '@yozora/character';
+import type { INodePoint } from '@yozora/character';
 /**
  * Try to match a footnote label.
  *
@@ -15,4 +15,4 @@ import type { NodePoint } from '@yozora/character';
  * @param endIndex
  * @see https://github.github.com/gfm/#link-label
  */
-export declare function eatFootnoteLabel(nodePoints: ReadonlyArray<NodePoint>, firstNonWhitespaceIndex: number, endIndex: number): number;
+export declare function eatFootnoteLabel(nodePoints: ReadonlyArray<INodePoint>, firstNonWhitespaceIndex: number, endIndex: number): number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yozora/tokenizer-footnote-definition",
-  "version": "1.3.0",
+  "version": "2.0.0-alpha.3",
   "author": {
     "name": "guanghechen",
     "url": "https://github.com/guanghechen/"
@@ -35,9 +35,9 @@
     "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/ast": "^2.0.0-alpha.3",
+    "@yozora/character": "^2.0.0-alpha.3",
+    "@yozora/core-tokenizer": "^2.0.0-alpha.3"
   },
-  "gitHead": "18c9b167004ad97718b2f94f25139f80598cbf7a"
+  "gitHead": "9f274fc7487a8c1dd213405d92508f9a7621f730"
 }