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

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 FootnoteReferenceTokenizer from '@yozora/tokenizer-footnote-reference'
 
-const parser = new DefaultYastParser()
-  .useBlockFallbackTokenizer(new ParagraphTokenizer())
-  .useInlineFallbackTokenizer(new TextTokenizer())
+const parser = new DefaultParser()
+  .useFallbackTokenizer(new ParagraphTokenizer())
+  .useFallbackTokenizer(new TextTokenizer())
   .useTokenizer(new FootnoteReferenceTokenizer())
 
 // 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

@@ -7,17 +7,12 @@ var character = require('@yozora/character');
 var coreTokenizer = require('@yozora/core-tokenizer');
 var tokenizerFootnoteDefinition = require('@yozora/tokenizer-footnote-definition');
 
-const uniqueName = '@yozora/tokenizer-footnote-reference';
-
-class FootnoteReferenceTokenizer 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.ATOMIC,
-        });
-    }
-    _findDelimiter(startIndex, endIndex, api) {
+const match = function (api) {
+    return {
+        findDelimiter: () => coreTokenizer.genFindDelimiter(_findDelimiter),
+        processSingleDelimiter,
+    };
+    function _findDelimiter(startIndex, endIndex) {
         const nodePoints = api.getNodePoints();
         for (let i = startIndex; i < endIndex; ++i) {
             const p = nodePoints[i];
@@ -40,7 +35,7 @@ class FootnoteReferenceTokenizer extends coreTokenizer.BaseInlineTokenizer {
         }
         return null;
     }
-    processSingleDelimiter(delimiter, api) {
+    function processSingleDelimiter(delimiter) {
         const nodePoints = api.getNodePoints();
         const labelAndIdentifier = coreTokenizer.resolveLinkLabelAndIdentifier(nodePoints, delimiter.startIndex + 2, delimiter.endIndex - 1);
         if (labelAndIdentifier == null)
@@ -57,17 +52,36 @@ class FootnoteReferenceTokenizer extends coreTokenizer.BaseInlineTokenizer {
         };
         return [token];
     }
-    parseInline(token) {
-        const { identifier, label } = token;
-        const result = {
-            type: ast.FootnoteReferenceType,
-            identifier,
-            label,
-        };
-        return result;
+};
+
+const parse = function (api) {
+    return {
+        parse: tokens => tokens.map(token => {
+            const { identifier, label } = token;
+            const node = api.shouldReservePosition
+                ? { type: ast.FootnoteReferenceType, position: api.calcPosition(token), identifier, label }
+                : { type: ast.FootnoteReferenceType, identifier, label };
+            return node;
+        }),
+    };
+};
+
+const uniqueName = '@yozora/tokenizer-footnote-reference';
+
+class FootnoteReferenceTokenizer 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.ATOMIC,
+        });
+        this.match = match;
+        this.parse = parse;
     }
 }
 
 exports.FootnoteReferenceTokenizer = FootnoteReferenceTokenizer;
 exports.FootnoteReferenceTokenizerName = uniqueName;
-exports['default'] = FootnoteReferenceTokenizer;
+exports["default"] = FootnoteReferenceTokenizer;
+exports.footnoteReferenceMatch = match;
+exports.footnoteReferenceParse = parse;

package/lib/esm/index.js

@@ -1,19 +1,14 @@
 import { FootnoteReferenceType } from '@yozora/ast';
 import { AsciiCodePoint } from '@yozora/character';
-import { BaseInlineTokenizer, TokenizerPriority, resolveLinkLabelAndIdentifier } from '@yozora/core-tokenizer';
+import { genFindDelimiter, resolveLinkLabelAndIdentifier, BaseInlineTokenizer, TokenizerPriority } from '@yozora/core-tokenizer';
 import { eatFootnoteLabel } from '@yozora/tokenizer-footnote-definition';
 
-const uniqueName = '@yozora/tokenizer-footnote-reference';
-
-class FootnoteReferenceTokenizer 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.ATOMIC,
-        });
-    }
-    _findDelimiter(startIndex, endIndex, api) {
+const match = function (api) {
+    return {
+        findDelimiter: () => genFindDelimiter(_findDelimiter),
+        processSingleDelimiter,
+    };
+    function _findDelimiter(startIndex, endIndex) {
         const nodePoints = api.getNodePoints();
         for (let i = startIndex; i < endIndex; ++i) {
             const p = nodePoints[i];
@@ -36,7 +31,7 @@ class FootnoteReferenceTokenizer extends BaseInlineTokenizer {
         }
         return null;
     }
-    processSingleDelimiter(delimiter, api) {
+    function processSingleDelimiter(delimiter) {
         const nodePoints = api.getNodePoints();
         const labelAndIdentifier = resolveLinkLabelAndIdentifier(nodePoints, delimiter.startIndex + 2, delimiter.endIndex - 1);
         if (labelAndIdentifier == null)
@@ -53,15 +48,32 @@ class FootnoteReferenceTokenizer extends BaseInlineTokenizer {
         };
         return [token];
     }
-    parseInline(token) {
-        const { identifier, label } = token;
-        const result = {
-            type: FootnoteReferenceType,
-            identifier,
-            label,
-        };
-        return result;
+};
+
+const parse = function (api) {
+    return {
+        parse: tokens => tokens.map(token => {
+            const { identifier, label } = token;
+            const node = api.shouldReservePosition
+                ? { type: FootnoteReferenceType, position: api.calcPosition(token), identifier, label }
+                : { type: FootnoteReferenceType, identifier, label };
+            return node;
+        }),
+    };
+};
+
+const uniqueName = '@yozora/tokenizer-footnote-reference';
+
+class FootnoteReferenceTokenizer 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.ATOMIC,
+        });
+        this.match = match;
+        this.parse = parse;
     }
 }
 
-export { FootnoteReferenceTokenizer, uniqueName as FootnoteReferenceTokenizerName, FootnoteReferenceTokenizer as default };
+export { FootnoteReferenceTokenizer, uniqueName as FootnoteReferenceTokenizerName, FootnoteReferenceTokenizer as default, match as footnoteReferenceMatch, parse as footnoteReferenceParse };

package/lib/types/index.d.ts

@@ -1,5 +1,5 @@
-import { FootnoteReferenceTokenizer } from './tokenizer';
-export { FootnoteReferenceTokenizer } from './tokenizer';
+export { match as footnoteReferenceMatch } from './match';
+export { parse as footnoteReferenceParse } from './parse';
+export { FootnoteReferenceTokenizer, FootnoteReferenceTokenizer as default } from './tokenizer';
 export { uniqueName as FootnoteReferenceTokenizerName } from './types';
-export type { Token as FootnoteReferenceToken, TokenizerProps as FootnoteReferenceTokenizerProps, } from './types';
-export default FootnoteReferenceTokenizer;
+export type { IThis as IFootnoteReferenceHookContext, IToken as IFootnoteReferenceToken, ITokenizerProps as IFootnoteReferenceTokenizerProps, } from './types';

package/lib/types/match.d.ts

@@ -0,0 +1,17 @@
+import type { IMatchInlineHookCreator } from '@yozora/core-tokenizer';
+import type { IDelimiter, IThis, IToken, T } from './types';
+/**
+ * A full footnote consists of a footnote label.
+ *
+ * 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.com/syntax-tree/mdast#footnotereference
+ * @see https://github.github.com/gfm/#link-label
+ */
+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,37 +1,13 @@
-import type { MatchInlinePhaseApi, ResultOfProcessSingleDelimiter, Tokenizer, TokenizerMatchInlineHook, TokenizerParseInlineHook } 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 footnote reference.
- *
- * A full footnote consists of a footnote label.
- *
- * 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.com/syntax-tree/mdast#footnotereference
  * @see https://github.github.com/gfm/#link-label
  */
-export declare class FootnoteReferenceTokenizer 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
-     */
-    processSingleDelimiter(delimiter: Delimiter, api: Readonly<MatchInlinePhaseApi>): ResultOfProcessSingleDelimiter<T, Token>;
-    /**
-     * @override
-     * @see TokenizerParseInlineHook
-     */
-    parseInline(token: Token): Node;
+export declare class FootnoteReferenceTokenizer 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,11 +1,12 @@
-import type { FootnoteReference, FootnoteReferenceType, YastAssociation } from '@yozora/ast';
-import type { BaseInlineTokenizerProps, PartialYastInlineToken, YastTokenDelimiter } from '@yozora/core-tokenizer';
+import type { Association, FootnoteReference, FootnoteReferenceType } from '@yozora/ast';
+import type { IBaseInlineTokenizerProps, IPartialYastInlineToken, ITokenizer, IYastTokenDelimiter } from '@yozora/core-tokenizer';
 export declare const uniqueName = "@yozora/tokenizer-footnote-reference";
 export declare type T = FootnoteReferenceType;
-export declare type Node = FootnoteReference;
-export interface Token extends PartialYastInlineToken<T>, YastAssociation {
+export declare type INode = FootnoteReference;
+export interface IToken extends IPartialYastInlineToken<T>, Association {
 }
-export interface Delimiter extends YastTokenDelimiter {
+export interface IDelimiter extends IYastTokenDelimiter {
     type: 'full';
 }
-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-reference",
-  "version": "1.3.0",
+  "version": "2.0.0-alpha.3",
   "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.3.0",
-    "@yozora/character": "^1.3.0",
-    "@yozora/core-tokenizer": "^1.3.0",
-    "@yozora/tokenizer-footnote-definition": "^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-footnote-definition": "^2.0.0-alpha.3"
   },
-  "gitHead": "18c9b167004ad97718b2f94f25139f80598cbf7a"
+  "gitHead": "9f274fc7487a8c1dd213405d92508f9a7621f730"
 }