@yozora/tokenizer-admonition 1.2.1 → 2.0.0-alpha.1

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 AdmonitionTokenizer from '@yozora/tokenizer-admonition'
 
-const parser = new DefaultYastParser()
-  .useBlockFallbackTokenizer(new ParagraphTokenizer())
-  .useInlineFallbackTokenizer(new TextTokenizer())
+const parser = new DefaultParser()
+  .useFallbackTokenizer(new ParagraphTokenizer())
+  .useFallbackTokenizer(new TextTokenizer())
   .useTokenizer(new AdmonitionTokenizer())
 
 // parse source markdown content
@@ -285,7 +285,6 @@ export interface Admonition extends YastParent<'admonition'> {
 [@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
@@ -345,7 +344,6 @@ export interface Admonition extends YastParent<'admonition'> {
 [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,18 +2,70 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+var FencedBlockTokenizer = require('@yozora/tokenizer-fenced-block');
 var ast = require('@yozora/ast');
 var character = require('@yozora/character');
 var coreTokenizer = require('@yozora/core-tokenizer');
-var FencedBlockTokenizer = require('@yozora/tokenizer-fenced-block');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
 var FencedBlockTokenizer__default = /*#__PURE__*/_interopDefaultLegacy(FencedBlockTokenizer);
 
+const match = function (api) {
+    const hook = FencedBlockTokenizer.fencedBlockMatch.call(this, api);
+    return Object.assign(Object.assign({}, hook), { isContainingBlock: true, onClose });
+    function onClose(token) {
+        const children = api.rollbackPhrasingLines(token.lines);
+        token.children = children;
+    }
+};
+
+const parse = function (api) {
+    return {
+        parse: tokens => tokens.map(token => {
+            const infoString = token.infoString;
+            let i = 0;
+            const keyword = [];
+            for (; i < infoString.length; ++i) {
+                const p = infoString[i];
+                if (character.isUnicodeWhitespaceCharacter(p.codePoint))
+                    break;
+                keyword.push(p);
+            }
+            i = coreTokenizer.eatOptionalWhitespaces(infoString, i, infoString.length);
+            const title = (() => {
+                if (i >= infoString.length)
+                    return [];
+                const titleLines = [
+                    {
+                        nodePoints: infoString,
+                        startIndex: i,
+                        endIndex: infoString.length,
+                        firstNonWhitespaceIndex: i,
+                        countOfPrecedeSpaces: 0,
+                    },
+                ];
+                const phrasingContent = api.buildPhrasingContent(titleLines);
+                if (phrasingContent == null)
+                    return [];
+                return api.parsePhrasingContent(phrasingContent);
+            })();
+            const children = token.children ? api.parseBlockTokens(token.children) : [];
+            const node = {
+                type: ast.AdmonitionType,
+                position: token.position,
+                keyword: character.calcEscapedStringFromNodePoints(keyword, 0, keyword.length, true),
+                title,
+                children,
+            };
+            return node;
+        }),
+    };
+};
+
 const uniqueName = '@yozora/tokenizer-admonition';
 
-class AdmonitionTokenizer extends FencedBlockTokenizer__default['default'] {
+class AdmonitionTokenizer extends FencedBlockTokenizer__default["default"] {
     constructor(props = {}) {
         var _a, _b;
         super({
@@ -23,50 +75,13 @@ class AdmonitionTokenizer extends FencedBlockTokenizer__default['default'] {
             markers: [character.AsciiCodePoint.COLON],
             markersRequired: 3,
         });
-        this.isContainingBlock = true;
-    }
-    onClose(token, api) {
-        const children = api.rollbackPhrasingLines(token.lines);
-        token.children = children;
-    }
-    parseBlock(token, children, api) {
-        const infoString = token.infoString;
-        let i = 0;
-        const keyword = [];
-        for (; i < infoString.length; ++i) {
-            const p = infoString[i];
-            if (character.isUnicodeWhitespaceCharacter(p.codePoint))
-                break;
-            keyword.push(p);
-        }
-        i = coreTokenizer.eatOptionalWhitespaces(infoString, i, infoString.length);
-        const title = (() => {
-            if (i >= infoString.length)
-                return [];
-            const titleLines = [
-                {
-                    nodePoints: infoString,
-                    startIndex: i,
-                    endIndex: infoString.length,
-                    firstNonWhitespaceIndex: i,
-                    countOfPrecedeSpaces: 0,
-                },
-            ];
-            const phrasingContent = api.buildPhrasingContent(titleLines);
-            if (phrasingContent == null)
-                return [];
-            return api.parsePhrasingContent(phrasingContent);
-        })();
-        const node = {
-            type: ast.AdmonitionType,
-            keyword: character.calcEscapedStringFromNodePoints(keyword, 0, keyword.length, true),
-            title,
-            children: children !== null && children !== void 0 ? children : [],
-        };
-        return node;
+        this.match = match;
+        this.parse = parse;
     }
 }
 
 exports.AdmonitionTokenizer = AdmonitionTokenizer;
 exports.AdmonitionTokenizerName = uniqueName;
-exports['default'] = AdmonitionTokenizer;
+exports.admonitionMatch = match;
+exports.admonitionParse = parse;
+exports["default"] = AdmonitionTokenizer;

package/lib/esm/index.js

@@ -1,7 +1,59 @@
+import FencedBlockTokenizer, { fencedBlockMatch } from '@yozora/tokenizer-fenced-block';
 import { AdmonitionType } from '@yozora/ast';
-import { AsciiCodePoint, isUnicodeWhitespaceCharacter, calcEscapedStringFromNodePoints } from '@yozora/character';
-import { TokenizerPriority, eatOptionalWhitespaces } from '@yozora/core-tokenizer';
-import FencedBlockTokenizer from '@yozora/tokenizer-fenced-block';
+import { isUnicodeWhitespaceCharacter, calcEscapedStringFromNodePoints, AsciiCodePoint } from '@yozora/character';
+import { eatOptionalWhitespaces, TokenizerPriority } from '@yozora/core-tokenizer';
+
+const match = function (api) {
+    const hook = fencedBlockMatch.call(this, api);
+    return Object.assign(Object.assign({}, hook), { isContainingBlock: true, onClose });
+    function onClose(token) {
+        const children = api.rollbackPhrasingLines(token.lines);
+        token.children = children;
+    }
+};
+
+const parse = function (api) {
+    return {
+        parse: tokens => tokens.map(token => {
+            const infoString = token.infoString;
+            let i = 0;
+            const keyword = [];
+            for (; i < infoString.length; ++i) {
+                const p = infoString[i];
+                if (isUnicodeWhitespaceCharacter(p.codePoint))
+                    break;
+                keyword.push(p);
+            }
+            i = eatOptionalWhitespaces(infoString, i, infoString.length);
+            const title = (() => {
+                if (i >= infoString.length)
+                    return [];
+                const titleLines = [
+                    {
+                        nodePoints: infoString,
+                        startIndex: i,
+                        endIndex: infoString.length,
+                        firstNonWhitespaceIndex: i,
+                        countOfPrecedeSpaces: 0,
+                    },
+                ];
+                const phrasingContent = api.buildPhrasingContent(titleLines);
+                if (phrasingContent == null)
+                    return [];
+                return api.parsePhrasingContent(phrasingContent);
+            })();
+            const children = token.children ? api.parseBlockTokens(token.children) : [];
+            const node = {
+                type: AdmonitionType,
+                position: token.position,
+                keyword: calcEscapedStringFromNodePoints(keyword, 0, keyword.length, true),
+                title,
+                children,
+            };
+            return node;
+        }),
+    };
+};
 
 const uniqueName = '@yozora/tokenizer-admonition';
 
@@ -15,48 +67,9 @@ class AdmonitionTokenizer extends FencedBlockTokenizer {
             markers: [AsciiCodePoint.COLON],
             markersRequired: 3,
         });
-        this.isContainingBlock = true;
-    }
-    onClose(token, api) {
-        const children = api.rollbackPhrasingLines(token.lines);
-        token.children = children;
-    }
-    parseBlock(token, children, api) {
-        const infoString = token.infoString;
-        let i = 0;
-        const keyword = [];
-        for (; i < infoString.length; ++i) {
-            const p = infoString[i];
-            if (isUnicodeWhitespaceCharacter(p.codePoint))
-                break;
-            keyword.push(p);
-        }
-        i = eatOptionalWhitespaces(infoString, i, infoString.length);
-        const title = (() => {
-            if (i >= infoString.length)
-                return [];
-            const titleLines = [
-                {
-                    nodePoints: infoString,
-                    startIndex: i,
-                    endIndex: infoString.length,
-                    firstNonWhitespaceIndex: i,
-                    countOfPrecedeSpaces: 0,
-                },
-            ];
-            const phrasingContent = api.buildPhrasingContent(titleLines);
-            if (phrasingContent == null)
-                return [];
-            return api.parsePhrasingContent(phrasingContent);
-        })();
-        const node = {
-            type: AdmonitionType,
-            keyword: calcEscapedStringFromNodePoints(keyword, 0, keyword.length, true),
-            title,
-            children: children !== null && children !== void 0 ? children : [],
-        };
-        return node;
+        this.match = match;
+        this.parse = parse;
     }
 }
 
-export { AdmonitionTokenizer, uniqueName as AdmonitionTokenizerName, AdmonitionTokenizer as default };
+export { AdmonitionTokenizer, uniqueName as AdmonitionTokenizerName, match as admonitionMatch, parse as admonitionParse, AdmonitionTokenizer as default };

package/lib/types/index.d.ts

@@ -1,5 +1,5 @@
-import { AdmonitionTokenizer } from './tokenizer';
-export { AdmonitionTokenizer } from './tokenizer';
+export { match as admonitionMatch } from './match';
+export { parse as admonitionParse } from './parse';
+export { AdmonitionTokenizer, AdmonitionTokenizer as default } from './tokenizer';
 export { uniqueName as AdmonitionTokenizerName } from './types';
-export type { Token as AdmonitionToken, TokenizerProps as AdmonitionTokenizerProps, } from './types';
-export default AdmonitionTokenizer;
+export type { IThis as IAdmonitionHookContext, IToken as IAdmonitionToken, ITokenizerProps as IAdmonitionTokenizerProps, } from './types';

package/lib/types/match.d.ts

@@ -0,0 +1,11 @@
+import type { IMatchBlockHookCreator } from '@yozora/core-tokenizer';
+import type { IThis, IToken, T } from './types';
+/**
+ * A code fence is a sequence of at least three consecutive backtick characters
+ * (`) or tildes (~). (Tildes and backticks cannot be mixed.) A fenced code
+ * block begins with a code fence, indented no more than three spaces.
+ *
+ * @see https://github.com/syntax-tree/mdast#code
+ * @see https://github.github.com/gfm/#code-fence
+ */
+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,29 +1,13 @@
-import type { YastNode } from '@yozora/ast';
-import type { MatchBlockPhaseApi, ParseBlockPhaseApi, ResultOfParse, Tokenizer, TokenizerMatchBlockHook, TokenizerParseBlockHook } from '@yozora/core-tokenizer';
+import type { IBlockTokenizer, IMatchBlockHookCreator, IParseBlockHookCreator } from '@yozora/core-tokenizer';
 import FencedBlockTokenizer from '@yozora/tokenizer-fenced-block';
-import type { Node, T, Token, TokenizerProps } from './types';
+import type { INode, IThis, IToken, ITokenizerProps, T } from './types';
 /**
  * Lexical Analyzer for Admonition.
- *
- * A code fence is a sequence of at least three consecutive backtick characters
- * (`) or tildes (~). (Tildes and backticks cannot be mixed.) A fenced code
- * block begins with a code fence, indented no more than three spaces.
- *
  * @see https://github.com/syntax-tree/mdast#code
  * @see https://github.github.com/gfm/#code-fence
  */
-export declare class AdmonitionTokenizer extends FencedBlockTokenizer<T> implements Tokenizer, TokenizerMatchBlockHook<T, Token>, TokenizerParseBlockHook<T, Token, Node> {
-    readonly isContainingBlock = true;
-    constructor(props?: TokenizerProps);
-    /**
-     * Resolve children.
-     * @override
-     * @see TokenizerMatchBlockHook
-     */
-    onClose(token: Token, api: MatchBlockPhaseApi): void;
-    /**
-     * @override
-     * @see TokenizerParseBlockHook
-     */
-    parseBlock(token: Token, children: YastNode[] | undefined, api: Readonly<ParseBlockPhaseApi>): ResultOfParse<T, Node>;
+export declare class AdmonitionTokenizer extends FencedBlockTokenizer<T, 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,13 +1,14 @@
-import type { Admonition, AdmonitionType } from '@yozora/ast';
-import type { BaseBlockTokenizerProps, YastBlockToken } from '@yozora/core-tokenizer';
-import type { FencedBlockToken } from '@yozora/tokenizer-fenced-block';
+import type { AdmonitionType, IAdmonition } from '@yozora/ast';
+import type { IBaseBlockTokenizerProps, IYastBlockToken } from '@yozora/core-tokenizer';
+import type { IFencedBlockHookContext, IFencedBlockToken } from '@yozora/tokenizer-fenced-block';
 export declare type T = AdmonitionType;
-export declare type Node = Admonition;
+export declare type INode = IAdmonition;
 export declare const uniqueName = "@yozora/tokenizer-admonition";
-export interface Token extends FencedBlockToken<T> {
+export interface IToken extends IFencedBlockToken<T> {
     /**
      *
      */
-    children?: YastBlockToken[];
+    children?: IYastBlockToken[];
 }
-export declare type TokenizerProps = Partial<BaseBlockTokenizerProps>;
+export declare type IThis = IFencedBlockHookContext<T>;
+export declare type ITokenizerProps = Partial<IBaseBlockTokenizerProps>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yozora/tokenizer-admonition",
-  "version": "1.2.1",
+  "version": "2.0.0-alpha.1",
   "description": "Tokenizer for processing admonitions",
   "author": {
     "name": "guanghechen",
@@ -42,10 +42,10 @@
     "test": "cross-env TS_NODE_FILES=true jest --config ../../jest.config.js --rootDir ."
   },
   "dependencies": {
-    "@yozora/ast": "^1.2.1",
-    "@yozora/character": "^1.2.1",
-    "@yozora/core-tokenizer": "^1.2.1",
-    "@yozora/tokenizer-fenced-block": "^1.2.1"
+    "@yozora/ast": "^2.0.0-alpha.1",
+    "@yozora/character": "^2.0.0-alpha.1",
+    "@yozora/core-tokenizer": "^2.0.0-alpha.1",
+    "@yozora/tokenizer-fenced-block": "^2.0.0-alpha.1"
   },
-  "gitHead": "d98d07d7c56dd9f6bb60149b2b0a4be2787e1046"
+  "gitHead": "86202e1d2b03ccfc2ab030517d9d314f7aee7666"
 }