@yozora/tokenizer-footnote 2.0.3 → 2.0.5-alpha.0

package/lib/cjs/{index.js → index.cjs}

@@ -80,18 +80,17 @@ 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,
+            name: props.name ?? uniqueName,
+            priority: props.priority ?? coreTokenizer.TokenizerPriority.LINKS,
         });
-        this.match = match;
-        this.parse = parse;
     }
+    match = match;
+    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 → index.mjs}

@@ -76,14 +76,13 @@ 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,
+            name: props.name ?? uniqueName,
+            priority: props.priority ?? TokenizerPriority.LINKS,
         });
-        this.match = match;
-        this.parse = parse;
     }
+    match = match;
+    parse = parse;
 }
 
 export { FootnoteTokenizer, uniqueName as FootnoteTokenizerName, FootnoteTokenizer as default, match as footnoteMatch, parse as footnoteParse };

package/lib/types/index.d.ts

@@ -1,18 +1,18 @@
 import { IPartialYastInlineToken, ITokenizer, IBaseInlineTokenizerProps, IYastTokenDelimiter, IMatchInlineHookCreator, IParseInlineHookCreator, BaseInlineTokenizer, IInlineTokenizer } from '@yozora/core-tokenizer';
 import { FootnoteType, Footnote } from '@yozora/ast';
 
-declare type T = FootnoteType;
-declare type INode = Footnote;
+type T = FootnoteType;
+type INode = Footnote;
 declare const uniqueName = "@yozora/tokenizer-footnote";
-declare type IToken = IPartialYastInlineToken<T>;
+type IToken = IPartialYastInlineToken<T>;
 interface IDelimiter extends IYastTokenDelimiter {
     /**
      * IDelimiter type.
      */
     type: 'opener' | 'closer';
 }
-declare type IThis = ITokenizer;
-declare type ITokenizerProps = Partial<IBaseInlineTokenizerProps>;
+type IThis = ITokenizer;
+type ITokenizerProps = Partial<IBaseInlineTokenizerProps>;
 
 /**
  * An inline footnote consists of a footnote text followed immediately by a right

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yozora/tokenizer-footnote",
-  "version": "2.0.3",
+  "version": "2.0.5-alpha.0",
   "author": {
     "name": "guanghechen",
     "url": "https://github.com/guanghechen/"
@@ -11,34 +11,38 @@
     "directory": "tokenizers/footnote"
   },
   "homepage": "https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/footnote",
-  "main": "lib/cjs/index.js",
-  "module": "lib/esm/index.js",
-  "types": "lib/types/index.d.ts",
-  "source": "src/index.ts",
+  "type": "module",
+  "exports": {
+    "types": "./lib/types/index.d.ts",
+    "import": "./lib/esm/index.mjs",
+    "require": "./lib/cjs/index.cjs"
+  },
+  "source": "./src/index.ts",
+  "types": "./lib/types/index.d.ts",
+  "main": "./lib/cjs/index.cjs",
+  "module": "./lib/esm/index.mjs",
   "license": "MIT",
   "engines": {
     "node": ">= 16.0.0"
   },
   "files": [
     "lib/",
-    "!lib/**/*.js.map",
-    "!lib/**/*.d.ts.map",
+    "src/",
     "package.json",
     "CHANGELOG.md",
     "LICENSE",
     "README.md"
   ],
   "scripts": {
-    "build": "cross-env NODE_ENV=production rollup -c ../../rollup.config.js",
-    "prebuild": "rimraf lib/",
+    "build": "rimraf lib/ && cross-env NODE_ENV=production rollup -c ../../rollup.config.mjs",
     "prepublishOnly": "cross-env ROLLUP_SHOULD_SOURCEMAP=false yarn build",
-    "test": "cross-env TS_NODE_FILES=true jest --config ../../jest.config.js --rootDir ."
+    "test": "cross-env TS_NODE_FILES=true NODE_OPTIONS=--experimental-vm-modules jest --config ../../jest.config.mjs --rootDir ."
   },
   "dependencies": {
-    "@yozora/ast": "^2.0.3",
-    "@yozora/character": "^2.0.3",
-    "@yozora/core-tokenizer": "^2.0.3",
-    "@yozora/tokenizer-link": "^2.0.3"
+    "@yozora/ast": "^2.0.5-alpha.0",
+    "@yozora/character": "^2.0.5-alpha.0",
+    "@yozora/core-tokenizer": "^2.0.5-alpha.0",
+    "@yozora/tokenizer-link": "^2.0.5-alpha.0"
   },
-  "gitHead": "8cc8f95cfebc8d752bc3272cdd24965f540c130b"
+  "gitHead": "8bf941fe4ef82947165b0f3cc123cd493665e13b"
 }

package/src/index.ts

@@ -0,0 +1,9 @@
+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 {
+  IThis as IFootnoteHookContext,
+  IToken as IFootnoteToken,
+  ITokenizerProps as IFootnoteTokenizerProps,
+} from './types'

package/src/match.ts

@@ -0,0 +1,102 @@
+import { FootnoteType } from '@yozora/ast'
+import type { INodePoint } from '@yozora/character'
+import { AsciiCodePoint } from '@yozora/character'
+import type {
+  IMatchInlineHookCreator,
+  IResultOfIsDelimiterPair,
+  IResultOfProcessDelimiterPair,
+  IYastInlineToken,
+} from '@yozora/core-tokenizer'
+import { genFindDelimiter } from '@yozora/core-tokenizer'
+import { checkBalancedBracketsStatus } from '@yozora/tokenizer-link'
+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 const match: IMatchInlineHookCreator<T, IDelimiter, IToken, IThis> = function (api) {
+  return {
+    findDelimiter: () => genFindDelimiter<IDelimiter>(_findDelimiter),
+    isDelimiterPair,
+    processDelimiterPair,
+  }
+
+  function _findDelimiter(startIndex: number, endIndex: number): IDelimiter | null {
+    const nodePoints: ReadonlyArray<INodePoint> = api.getNodePoints()
+
+    for (let i = startIndex; i < endIndex; ++i) {
+      const c = nodePoints[i].codePoint
+      switch (c) {
+        case AsciiCodePoint.BACKSLASH:
+          i += 1
+          break
+        case AsciiCodePoint.CARET: {
+          if (i + 1 < endIndex && nodePoints[i + 1].codePoint === AsciiCodePoint.OPEN_BRACKET) {
+            return {
+              type: 'opener',
+              startIndex: i,
+              endIndex: i + 2,
+            }
+          }
+          break
+        }
+        case AsciiCodePoint.CLOSE_BRACKET:
+          return {
+            type: 'closer',
+            startIndex: i,
+            endIndex: i + 1,
+          }
+      }
+    }
+    return null
+  }
+
+  function isDelimiterPair(
+    openerDelimiter: IDelimiter,
+    closerDelimiter: IDelimiter,
+    internalTokens: ReadonlyArray<IYastInlineToken>,
+  ): IResultOfIsDelimiterPair {
+    const nodePoints: ReadonlyArray<INodePoint> = api.getNodePoints()
+    const balancedBracketsStatus: -1 | 0 | 1 = checkBalancedBracketsStatus(
+      openerDelimiter.endIndex,
+      closerDelimiter.startIndex,
+      internalTokens,
+      nodePoints,
+    )
+    switch (balancedBracketsStatus) {
+      case -1:
+        return { paired: false, opener: false, closer: true }
+      case 0:
+        return { paired: true }
+      case 1:
+        return { paired: false, opener: true, closer: false }
+    }
+  }
+
+  function processDelimiterPair(
+    openerDelimiter: IDelimiter,
+    closerDelimiter: IDelimiter,
+    internalTokens: ReadonlyArray<IYastInlineToken>,
+  ): IResultOfProcessDelimiterPair<T, IToken, IDelimiter> {
+    const token: IToken = {
+      nodeType: FootnoteType,
+      startIndex: openerDelimiter.startIndex,
+      endIndex: closerDelimiter.endIndex,
+      children: api.resolveInternalTokens(
+        internalTokens,
+        openerDelimiter.endIndex,
+        closerDelimiter.startIndex,
+      ),
+    }
+    return { tokens: [token] }
+  }
+}

package/src/parse.ts

@@ -0,0 +1,17 @@
+import type { Node } from '@yozora/ast'
+import { FootnoteType } from '@yozora/ast'
+import type { IParseInlineHookCreator } from '@yozora/core-tokenizer'
+import type { INode, IThis, IToken, T } from './types'
+
+export const parse: IParseInlineHookCreator<T, IToken, INode, IThis> = function (api) {
+  return {
+    parse: tokens =>
+      tokens.map(token => {
+        const children: Node[] = api.parseInlineTokens(token.children)
+        const node: INode = api.shouldReservePosition
+          ? { type: FootnoteType, position: api.calcPosition(token), children }
+          : { type: FootnoteType, children }
+        return node
+      }),
+  }
+}

package/src/tokenizer.ts

@@ -0,0 +1,35 @@
+import type {
+  IInlineTokenizer,
+  IMatchInlineHookCreator,
+  IParseInlineHookCreator,
+} from '@yozora/core-tokenizer'
+import { BaseInlineTokenizer, TokenizerPriority } from '@yozora/core-tokenizer'
+import { match } from './match'
+import { parse } from './parse'
+import type { IDelimiter, INode, IThis, IToken, ITokenizerProps, T } from './types'
+import { uniqueName } from './types'
+
+/**
+ * Lexical Analyzer for inline 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 class FootnoteTokenizer
+  extends BaseInlineTokenizer<T, IDelimiter, IToken, INode, IThis>
+  implements IInlineTokenizer<T, IDelimiter, IToken, INode, IThis>
+{
+  /* istanbul ignore next */
+  constructor(props: ITokenizerProps = {}) {
+    super({
+      name: props.name ?? uniqueName,
+      priority: props.priority ?? TokenizerPriority.LINKS,
+    })
+  }
+
+  public override readonly match: IMatchInlineHookCreator<T, IDelimiter, IToken, IThis> = match
+
+  public override readonly parse: IParseInlineHookCreator<T, IToken, INode, IThis> = parse
+}

package/src/types.ts

@@ -0,0 +1,24 @@
+import type { Footnote, FootnoteType } from '@yozora/ast'
+import type {
+  IBaseInlineTokenizerProps,
+  IPartialYastInlineToken,
+  ITokenizer,
+  IYastTokenDelimiter,
+} from '@yozora/core-tokenizer'
+
+export type T = FootnoteType
+export type INode = Footnote
+export const uniqueName = '@yozora/tokenizer-footnote'
+
+export type IToken = IPartialYastInlineToken<T>
+
+export interface IDelimiter extends IYastTokenDelimiter {
+  /**
+   * IDelimiter type.
+   */
+  type: 'opener' | 'closer'
+}
+
+export type IThis = ITokenizer
+
+export type ITokenizerProps = Partial<IBaseInlineTokenizerProps>