@yozora/tokenizer-blockquote 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 BlockquoteTokenizer from '@yozora/tokenizer-blockquote'
 
-const parser = new DefaultYastParser()
-  .useBlockFallbackTokenizer(new ParagraphTokenizer())
-  .useInlineFallbackTokenizer(new TextTokenizer())
+const parser = new DefaultParser()
+  .useFallbackTokenizer(new ParagraphTokenizer())
+  .useFallbackTokenizer(new TextTokenizer())
   .useTokenizer(new BlockquoteTokenizer())
 
 // parse source markdown content
@@ -233,7 +233,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
@@ -293,7 +292,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

@@ -6,31 +6,24 @@ var ast = require('@yozora/ast');
 var character = require('@yozora/character');
 var coreTokenizer = require('@yozora/core-tokenizer');
 
-const uniqueName = '@yozora/tokenizer-blockquote';
-
-class BlockquoteTokenizer 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;
-    }
-    eatOpener(line) {
+const match = function () {
+    return {
+        isContainingBlock: true,
+        eatOpener,
+        eatAndInterruptPreviousSibling,
+        eatContinuationText,
+    };
+    function eatOpener(line) {
         if (line.countOfPrecedeSpaces >= 4)
             return null;
         const { nodePoints, startIndex, endIndex, firstNonWhitespaceIndex } = line;
         if (firstNonWhitespaceIndex >= endIndex ||
-            nodePoints[firstNonWhitespaceIndex].codePoint !==
-                character.AsciiCodePoint.CLOSE_ANGLE)
+            nodePoints[firstNonWhitespaceIndex].codePoint !== character.AsciiCodePoint.CLOSE_ANGLE)
             return null;
         let nextIndex = firstNonWhitespaceIndex + 1;
-        if (nextIndex < endIndex &&
-            character.isSpaceCharacter(nodePoints[nextIndex].codePoint)) {
+        if (nextIndex < endIndex && character.isSpaceCharacter(nodePoints[nextIndex].codePoint)) {
             nextIndex += 1;
-            if (nextIndex < endIndex &&
-                nodePoints[nextIndex].codePoint === character.VirtualCodePoint.SPACE) {
+            if (nextIndex < endIndex && nodePoints[nextIndex].codePoint === character.VirtualCodePoint.SPACE) {
                 nextIndex += 1;
             }
         }
@@ -44,8 +37,8 @@ class BlockquoteTokenizer extends coreTokenizer.BaseBlockTokenizer {
         };
         return { token, nextIndex };
     }
-    eatAndInterruptPreviousSibling(line, prevSiblingToken) {
-        const result = this.eatOpener(line);
+    function eatAndInterruptPreviousSibling(line, prevSiblingToken) {
+        const result = eatOpener(line);
         if (result == null)
             return null;
         return {
@@ -54,12 +47,11 @@ class BlockquoteTokenizer extends coreTokenizer.BaseBlockTokenizer {
             remainingSibling: prevSiblingToken,
         };
     }
-    eatContinuationText(line, token, parentToken) {
-        const { nodePoints, startIndex, endIndex, firstNonWhitespaceIndex, countOfPrecedeSpaces, } = line;
+    function eatContinuationText(line, token, parentToken) {
+        const { nodePoints, startIndex, endIndex, firstNonWhitespaceIndex, countOfPrecedeSpaces } = line;
         if (countOfPrecedeSpaces >= 4 ||
             firstNonWhitespaceIndex >= endIndex ||
-            nodePoints[firstNonWhitespaceIndex].codePoint !==
-                character.AsciiCodePoint.CLOSE_ANGLE) {
+            nodePoints[firstNonWhitespaceIndex].codePoint !== character.AsciiCodePoint.CLOSE_ANGLE) {
             if (parentToken.nodeType === ast.BlockquoteType) {
                 return { status: 'opening', nextIndex: startIndex };
             }
@@ -71,12 +63,36 @@ class BlockquoteTokenizer extends coreTokenizer.BaseBlockTokenizer {
             : firstNonWhitespaceIndex + 1;
         return { status: 'opening', nextIndex };
     }
-    parseBlock(token, children) {
-        const node = { type: ast.BlockquoteType, children };
-        return node;
+};
+
+const parse = function (api) {
+    return {
+        parse: tokens => tokens.map(token => {
+            const children = api.parseBlockTokens(token.children);
+            const node = api.shouldReservePosition
+                ? { type: ast.BlockquoteType, position: token.position, children }
+                : { type: ast.BlockquoteType, children };
+            return node;
+        }),
+    };
+};
+
+const uniqueName = '@yozora/tokenizer-blockquote';
+
+class BlockquoteTokenizer 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.match = match;
+        this.parse = parse;
     }
 }
 
 exports.BlockquoteTokenizer = BlockquoteTokenizer;
 exports.BlockquoteTokenizerName = uniqueName;
-exports['default'] = BlockquoteTokenizer;
+exports.blockquoteMatch = match;
+exports.blockquoteParse = parse;
+exports["default"] = BlockquoteTokenizer;

package/lib/esm/index.js

@@ -1,32 +1,25 @@
 import { BlockquoteType } from '@yozora/ast';
 import { AsciiCodePoint, isSpaceCharacter, VirtualCodePoint } from '@yozora/character';
-import { BaseBlockTokenizer, TokenizerPriority, calcStartYastNodePoint, calcEndYastNodePoint } from '@yozora/core-tokenizer';
+import { calcStartYastNodePoint, calcEndYastNodePoint, BaseBlockTokenizer, TokenizerPriority } from '@yozora/core-tokenizer';
 
-const uniqueName = '@yozora/tokenizer-blockquote';
-
-class BlockquoteTokenizer 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;
-    }
-    eatOpener(line) {
+const match = function () {
+    return {
+        isContainingBlock: true,
+        eatOpener,
+        eatAndInterruptPreviousSibling,
+        eatContinuationText,
+    };
+    function eatOpener(line) {
         if (line.countOfPrecedeSpaces >= 4)
             return null;
         const { nodePoints, startIndex, endIndex, firstNonWhitespaceIndex } = line;
         if (firstNonWhitespaceIndex >= endIndex ||
-            nodePoints[firstNonWhitespaceIndex].codePoint !==
-                AsciiCodePoint.CLOSE_ANGLE)
+            nodePoints[firstNonWhitespaceIndex].codePoint !== AsciiCodePoint.CLOSE_ANGLE)
             return null;
         let nextIndex = firstNonWhitespaceIndex + 1;
-        if (nextIndex < endIndex &&
-            isSpaceCharacter(nodePoints[nextIndex].codePoint)) {
+        if (nextIndex < endIndex && isSpaceCharacter(nodePoints[nextIndex].codePoint)) {
             nextIndex += 1;
-            if (nextIndex < endIndex &&
-                nodePoints[nextIndex].codePoint === VirtualCodePoint.SPACE) {
+            if (nextIndex < endIndex && nodePoints[nextIndex].codePoint === VirtualCodePoint.SPACE) {
                 nextIndex += 1;
             }
         }
@@ -40,8 +33,8 @@ class BlockquoteTokenizer extends BaseBlockTokenizer {
         };
         return { token, nextIndex };
     }
-    eatAndInterruptPreviousSibling(line, prevSiblingToken) {
-        const result = this.eatOpener(line);
+    function eatAndInterruptPreviousSibling(line, prevSiblingToken) {
+        const result = eatOpener(line);
         if (result == null)
             return null;
         return {
@@ -50,12 +43,11 @@ class BlockquoteTokenizer extends BaseBlockTokenizer {
             remainingSibling: prevSiblingToken,
         };
     }
-    eatContinuationText(line, token, parentToken) {
-        const { nodePoints, startIndex, endIndex, firstNonWhitespaceIndex, countOfPrecedeSpaces, } = line;
+    function eatContinuationText(line, token, parentToken) {
+        const { nodePoints, startIndex, endIndex, firstNonWhitespaceIndex, countOfPrecedeSpaces } = line;
         if (countOfPrecedeSpaces >= 4 ||
             firstNonWhitespaceIndex >= endIndex ||
-            nodePoints[firstNonWhitespaceIndex].codePoint !==
-                AsciiCodePoint.CLOSE_ANGLE) {
+            nodePoints[firstNonWhitespaceIndex].codePoint !== AsciiCodePoint.CLOSE_ANGLE) {
             if (parentToken.nodeType === BlockquoteType) {
                 return { status: 'opening', nextIndex: startIndex };
             }
@@ -67,10 +59,32 @@ class BlockquoteTokenizer extends BaseBlockTokenizer {
             : firstNonWhitespaceIndex + 1;
         return { status: 'opening', nextIndex };
     }
-    parseBlock(token, children) {
-        const node = { type: BlockquoteType, children };
-        return node;
+};
+
+const parse = function (api) {
+    return {
+        parse: tokens => tokens.map(token => {
+            const children = api.parseBlockTokens(token.children);
+            const node = api.shouldReservePosition
+                ? { type: BlockquoteType, position: token.position, children }
+                : { type: BlockquoteType, children };
+            return node;
+        }),
+    };
+};
+
+const uniqueName = '@yozora/tokenizer-blockquote';
+
+class BlockquoteTokenizer 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.match = match;
+        this.parse = parse;
     }
 }
 
-export { BlockquoteTokenizer, uniqueName as BlockquoteTokenizerName, BlockquoteTokenizer as default };
+export { BlockquoteTokenizer, uniqueName as BlockquoteTokenizerName, match as blockquoteMatch, parse as blockquoteParse, BlockquoteTokenizer as default };

package/lib/types/index.d.ts

@@ -1,5 +1,5 @@
-import { BlockquoteTokenizer } from './tokenizer';
-export { BlockquoteTokenizer } from './tokenizer';
+export { match as blockquoteMatch } from './match';
+export { parse as blockquoteParse } from './parse';
+export { BlockquoteTokenizer, BlockquoteTokenizer as default } from './tokenizer';
 export { uniqueName as BlockquoteTokenizerName } from './types';
-export type { Token as BlockquoteToken, TokenizerProps as BlockquoteTokenizerProps, } from './types';
-export default BlockquoteTokenizer;
+export type { IThis as IBlockquoteHookContext, IToken as IBlockquoteToken, ITokenizerProps as IBlockquoteTokenizerProps, } from './types';

package/lib/types/match.d.ts

@@ -0,0 +1,27 @@
+import type { IMatchBlockHookCreator } from '@yozora/core-tokenizer';
+import type { IThis, IToken, T } from './types';
+/**
+ * A block quote marker consists of 0-3 spaces of initial indent, plus
+ *  (a) the character > together with a following space, or
+ *  (b) a single character > not followed by a space.
+ *
+ * The following rules define block quotes:
+ *  - Basic case. If a string of lines Ls constitute a sequence of blocks Bs,
+ *    then the result of prepending a block quote marker to the beginning of
+ *    each line in Ls is a block quote containing Bs.
+ *
+ *  - Laziness. If a string of lines Ls constitute a block quote with contents
+ *    Bs, then the result of deleting the initial block quote marker from one
+ *    or more lines in which the next non-whitespace character after the block
+ *    quote marker is paragraph continuation text is a block quote with Bs as
+ *    its content. Paragraph continuation text is text that will be parsed as
+ *    part of the content of a paragraph, but does not occur at the beginning
+ *    of the paragraph.
+ *
+ *  - Consecutiveness. A document cannot contain two block quotes in a row
+ *    unless there is a blank line between them.
+ *
+ * @see https://github.com/syntax-tree/mdast#blockquote
+ * @see https://github.github.com/gfm/#block-quotes
+ */
+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,54 +1,13 @@
-import type { YastNode } from '@yozora/ast';
-import type { PhrasingContentLine, ResultOfEatAndInterruptPreviousSibling, ResultOfEatContinuationText, ResultOfEatOpener, ResultOfParse, Tokenizer, TokenizerMatchBlockHook, TokenizerParseBlockHook, YastBlockToken } 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 Blockquote.
- *
- * A block quote marker consists of 0-3 spaces of initial indent, plus
- *  (a) the character > together with a following space, or
- *  (b) a single character > not followed by a space.
- *
- * The following rules define block quotes:
- *  - Basic case. If a string of lines Ls constitute a sequence of blocks Bs,
- *    then the result of prepending a block quote marker to the beginning of
- *    each line in Ls is a block quote containing Bs.
- *
- *  - Laziness. If a string of lines Ls constitute a block quote with contents
- *    Bs, then the result of deleting the initial block quote marker from one
- *    or more lines in which the next non-whitespace character after the block
- *    quote marker is paragraph continuation text is a block quote with Bs as
- *    its content. Paragraph continuation text is text that will be parsed as
- *    part of the content of a paragraph, but does not occur at the beginning
- *    of the paragraph.
- *
- *  - Consecutiveness. A document cannot contain two block quotes in a row
- *    unless there is a blank line between them.
- *
  * @see https://github.com/syntax-tree/mdast#blockquote
  * @see https://github.github.com/gfm/#block-quotes
  */
-export declare class BlockquoteTokenizer extends BaseBlockTokenizer implements Tokenizer, TokenizerMatchBlockHook<T, Token>, TokenizerParseBlockHook<T, Token, Node> {
-    readonly isContainingBlock = true;
-    constructor(props?: TokenizerProps);
-    /**
-     * @override
-     * @see TokenizerMatchBlockHook
-     */
-    eatOpener(line: Readonly<PhrasingContentLine>): ResultOfEatOpener<T, Token>;
-    /**
-     * @override
-     * @see TokenizerMatchBlockHook
-     */
-    eatAndInterruptPreviousSibling(line: Readonly<PhrasingContentLine>, prevSiblingToken: Readonly<YastBlockToken>): ResultOfEatAndInterruptPreviousSibling<T, Token>;
-    /**
-     * @override
-     * @see TokenizerMatchBlockHook
-     */
-    eatContinuationText(line: Readonly<PhrasingContentLine>, token: Token, parentToken: Readonly<YastBlockToken>): ResultOfEatContinuationText;
-    /**
-     * @override
-     * @see TokenizerParseBlockHook
-     */
-    parseBlock(token: Readonly<Token>, children: YastNode[]): ResultOfParse<T, Node>;
+export declare class BlockquoteTokenizer extends BaseBlockTokenizer<T, IToken, INode, IThis> implements IBlockTokenizer<T, IToken, INode, IThis> {
+    constructor(props?: ITokenizerProps);
+    readonly match: IMatchBlockHookCreator<T, IToken, IThis>;
+    readonly parse: IParseBlockHookCreator<T, IToken, INode, IThis>;
 }

package/lib/types/types.d.ts

@@ -1,12 +1,13 @@
 import type { Blockquote, BlockquoteType } from '@yozora/ast';
-import type { BaseBlockTokenizerProps, PartialYastBlockToken, YastBlockToken } from '@yozora/core-tokenizer';
+import type { IBaseBlockTokenizerProps, IPartialYastBlockToken, ITokenizer, IYastBlockToken } from '@yozora/core-tokenizer';
 export declare type T = BlockquoteType;
-export declare type Node = Blockquote;
+export declare type INode = Blockquote;
 export declare const uniqueName = "@yozora/tokenizer-blockquote";
-export interface Token extends PartialYastBlockToken<T> {
+export interface IToken extends IPartialYastBlockToken<T> {
     /**
      *
      */
-    children: YastBlockToken[];
+    children: IYastBlockToken[];
 }
-export declare type TokenizerProps = Partial<BaseBlockTokenizerProps>;
+export declare type IThis = ITokenizer;
+export declare type ITokenizerProps = Partial<IBaseBlockTokenizerProps>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yozora/tokenizer-blockquote",
-  "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"
 }