@yozora/tokenizer-image-reference 2.0.4 → 2.0.5

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

@@ -157,18 +157,17 @@ const uniqueName = '@yozora/tokenizer-image-reference';
 
 class ImageReferenceTokenizer 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.ImageReferenceTokenizer = ImageReferenceTokenizer;
 exports.ImageReferenceTokenizerName = uniqueName;
-exports["default"] = ImageReferenceTokenizer;
+exports.default = ImageReferenceTokenizer;
 exports.imageReferenceMatch = match;
 exports.imageReferenceParse = parse;

package/lib/esm/{index.js → index.mjs}

@@ -153,14 +153,13 @@ const uniqueName = '@yozora/tokenizer-image-reference';
 
 class ImageReferenceTokenizer 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 { ImageReferenceTokenizer, uniqueName as ImageReferenceTokenizerName, ImageReferenceTokenizer as default, match as imageReferenceMatch, parse as imageReferenceParse };

package/lib/types/index.d.ts

@@ -3,15 +3,15 @@ import { Association, Reference, ImageReferenceType, ImageReference } from '@yoz
 import { ILinkReferenceDelimiterBracket } from '@yozora/tokenizer-link-reference';
 
 declare const uniqueName = "@yozora/tokenizer-image-reference";
-declare type T = ImageReferenceType;
-declare type INode = ImageReference;
+type T = ImageReferenceType;
+type INode = ImageReference;
 interface IToken extends IPartialYastInlineToken<T>, Association, Reference {
 }
 interface IDelimiter extends IYastTokenDelimiter {
     brackets: ILinkReferenceDelimiterBracket[];
 }
-declare type IThis = ITokenizer;
-declare type ITokenizerProps = Partial<IBaseInlineTokenizerProps>;
+type IThis = ITokenizer;
+type ITokenizerProps = Partial<IBaseInlineTokenizerProps>;
 
 /**
  * Syntax for image-references is like the syntax for link-references, with one

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yozora/tokenizer-image-reference",
-  "version": "2.0.4",
+  "version": "2.0.5",
   "author": {
     "name": "guanghechen",
     "url": "https://github.com/guanghechen/"
@@ -11,36 +11,40 @@
     "directory": "tokenizers/image-reference"
   },
   "homepage": "https://github.com/yozorajs/yozora/tree/release-2.x.x/tokenizers/image-reference",
-  "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.4",
-    "@yozora/character": "^2.0.4",
-    "@yozora/core-tokenizer": "^2.0.4",
-    "@yozora/tokenizer-image": "^2.0.4",
-    "@yozora/tokenizer-link": "^2.0.4",
-    "@yozora/tokenizer-link-reference": "^2.0.4"
+    "@yozora/ast": "^2.0.5",
+    "@yozora/character": "^2.0.5",
+    "@yozora/core-tokenizer": "^2.0.5",
+    "@yozora/tokenizer-image": "^2.0.5",
+    "@yozora/tokenizer-link": "^2.0.5",
+    "@yozora/tokenizer-link-reference": "^2.0.5"
   },
-  "gitHead": "c980b95254394dcacba0cbb4bea251350b09397c"
+  "gitHead": "7ba3bab49fe65cf2f57082c0503af73da9356cf0"
 }

package/src/index.ts

@@ -0,0 +1,9 @@
+export { match as imageReferenceMatch } from './match'
+export { parse as imageReferenceParse } from './parse'
+export { ImageReferenceTokenizer, ImageReferenceTokenizer as default } from './tokenizer'
+export { uniqueName as ImageReferenceTokenizerName } from './types'
+export type {
+  IThis as IImageReferenceHookContext,
+  IToken as IImageReferenceToken,
+  ITokenizerProps as IImageReferenceTokenizerProps,
+} from './types'

package/src/match.ts

@@ -0,0 +1,206 @@
+import { ImageReferenceType } 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 { eatLinkLabel, genFindDelimiter } from '@yozora/core-tokenizer'
+import { checkBalancedBracketsStatus } from '@yozora/tokenizer-link'
+import type { IDelimiter, IThis, IToken, T } from './types'
+
+/**
+ * Syntax for image-references is like the syntax for link-references, with one
+ * difference. Instead of link text, we have an image description. The rules for
+ * this are the same as for link text, except that
+ *
+ *  a) an image description starts with '![' rather than '[', and
+ *  b) an image description may contain links.
+ *
+ * An image description has inline elements as its contents. When an image is
+ * rendered to HTML, this is standardly used as the image’s alt attribute.
+ *
+ * One type of opener delimiter: '!['
+ *
+ * Three types of closer delimiter: ']', '][]' something like '][bar]'
+ *
+ * ------
+ *
+ * A 'opener' type delimiter is one of the following forms:
+ *
+ *  - '!['
+ *
+ * A 'closer' type delimiter is one of the following forms:
+ *
+ *  - ']'
+ *  - '][]'
+ *  - '][identifier]'
+ *
+ * @see https://github.com/syntax-tree/mdast#imagereference
+ * @see https://github.github.com/gfm/#images
+ */
+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.EXCLAMATION_MARK: {
+          if (i + 1 >= endIndex || nodePoints[i + 1].codePoint !== AsciiCodePoint.OPEN_BRACKET) {
+            break
+          }
+
+          return {
+            type: 'opener',
+            startIndex: i,
+            endIndex: i + 2,
+            brackets: [],
+          }
+        }
+        case AsciiCodePoint.CLOSE_BRACKET: {
+          const delimiter: IDelimiter = {
+            type: 'closer',
+            startIndex: i,
+            endIndex: i + 1,
+            brackets: [],
+          }
+
+          if (i + 1 >= endIndex || nodePoints[i + 1].codePoint !== AsciiCodePoint.OPEN_BRACKET) {
+            return delimiter
+          }
+
+          const result = eatLinkLabel(nodePoints, i + 1, endIndex)
+
+          // It's something like ']['
+          if (result.nextIndex < 0) return delimiter
+
+          // It's something like '][]'
+          if (result.labelAndIdentifier == null) {
+            return {
+              type: 'closer',
+              startIndex: i,
+              endIndex: result.nextIndex,
+              brackets: [
+                {
+                  startIndex: i + 1,
+                  endIndex: result.nextIndex,
+                },
+              ],
+            }
+          }
+
+          return {
+            type: 'closer',
+            startIndex: i,
+            endIndex: result.nextIndex,
+            brackets: [
+              {
+                startIndex: i + 1,
+                endIndex: result.nextIndex,
+                label: result.labelAndIdentifier.label,
+                identifier: result.labelAndIdentifier.identifier,
+              },
+            ],
+          }
+        }
+      }
+    }
+    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 nodePoints: ReadonlyArray<INodePoint> = api.getNodePoints()
+    const bracket = closerDelimiter.brackets[0]
+    if (bracket != null && bracket.identifier != null) {
+      if (api.hasDefinition(bracket.identifier)) {
+        const token: IToken = {
+          nodeType: ImageReferenceType,
+          startIndex: openerDelimiter.startIndex,
+          endIndex: bracket.endIndex,
+          referenceType: 'full',
+          label: bracket.label!,
+          identifier: bracket.identifier,
+          children: api.resolveInternalTokens(
+            internalTokens,
+            openerDelimiter.endIndex,
+            closerDelimiter.startIndex,
+          ),
+        }
+        return { tokens: [token] }
+      }
+
+      /**
+       * A shortcut type of link-reference / image-reference could not followed
+       * by a link label (even though it is not defined).
+       * @see https://github.github.com/gfm/#example-579
+       */
+      return { tokens: internalTokens }
+    }
+
+    const { nextIndex, labelAndIdentifier } = eatLinkLabel(
+      nodePoints,
+      openerDelimiter.endIndex - 1,
+      closerDelimiter.startIndex + 1,
+    )
+    if (
+      nextIndex === closerDelimiter.startIndex + 1 &&
+      labelAndIdentifier != null &&
+      api.hasDefinition(labelAndIdentifier.identifier)
+    ) {
+      const token: IToken = {
+        nodeType: ImageReferenceType,
+        startIndex: openerDelimiter.startIndex,
+        endIndex: closerDelimiter.endIndex,
+        referenceType: bracket == null ? 'shortcut' : 'collapsed',
+        label: labelAndIdentifier.label,
+        identifier: labelAndIdentifier.identifier,
+        children: api.resolveInternalTokens(
+          internalTokens,
+          openerDelimiter.endIndex,
+          closerDelimiter.startIndex,
+        ),
+      }
+      return { tokens: [token] }
+    }
+
+    return { tokens: internalTokens }
+  }
+}

package/src/parse.ts

@@ -0,0 +1,36 @@
+import type { Node } from '@yozora/ast'
+import { ImageReferenceType } from '@yozora/ast'
+import type { IParseInlineHookCreator } from '@yozora/core-tokenizer'
+import { calcImageAlt } from '@yozora/tokenizer-image'
+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 { identifier, label, referenceType } = token
+
+        // calc alt
+        const children: Node[] = api.parseInlineTokens(token.children)
+        const alt = calcImageAlt(children)
+
+        const node: INode = api.shouldReservePosition
+          ? {
+              type: ImageReferenceType,
+              position: api.calcPosition(token),
+              identifier,
+              label,
+              referenceType,
+              alt,
+            }
+          : {
+              type: ImageReferenceType,
+              identifier,
+              label,
+              referenceType,
+              alt,
+            }
+        return node
+      }),
+  }
+}

package/src/tokenizer.ts

@@ -0,0 +1,32 @@
+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 ImageReference.
+ * @see https://github.com/syntax-tree/mdast#imagereference
+ * @see https://github.github.com/gfm/#images
+ */
+export class ImageReferenceTokenizer
+  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,23 @@
+import type { Association, ImageReference, ImageReferenceType, Reference } from '@yozora/ast'
+import type {
+  IBaseInlineTokenizerProps,
+  IPartialYastInlineToken,
+  ITokenizer,
+  IYastTokenDelimiter,
+} from '@yozora/core-tokenizer'
+import type { ILinkReferenceDelimiterBracket } from '@yozora/tokenizer-link-reference'
+
+export const uniqueName = '@yozora/tokenizer-image-reference'
+
+export type T = ImageReferenceType
+export type INode = ImageReference
+
+export interface IToken extends IPartialYastInlineToken<T>, Association, Reference {}
+
+export interface IDelimiter extends IYastTokenDelimiter {
+  brackets: ILinkReferenceDelimiterBracket[]
+}
+
+export type IThis = ITokenizer
+
+export type ITokenizerProps = Partial<IBaseInlineTokenizerProps>