outline/shared/editor/rules/emoji.ts

import type MarkdownIt from "markdown-it";
import type StateInline from "markdown-it/lib/rules_inline/state_inline.mjs";
import { full as emojiPlugin } from "markdown-it-emoji";
import { isUUID } from "validator";
import { nameToEmoji } from "../lib/emoji";

type Options = {
  emoji: boolean;
};

/**
 * Custom markdown-it inline rule to parse UUID-based custom emojis in the format :uuid:
 * This catches custom emoji UUID patterns that the standard emoji plugin doesn't recognize.
 *
 * @param state - The markdown-it state object for inline parsing.
 * @param silent - When true, only checks if the rule matches without creating tokens.
 * @returns True if the rule matched and processed content, false otherwise.
 */
function customEmojiRule(state: StateInline, silent: boolean) {
  const start = state.pos;
  const max = state.posMax;

  // Must start with a colon
  if (state.src.charCodeAt(start) !== 0x3a /* : */) {
    return false;
  }

  // Find the closing colon
  let pos = start + 1;
  while (pos < max && state.src.charCodeAt(pos) !== 0x3a /* : */) {
    pos++;
  }

  // No closing colon found
  if (pos >= max) {
    return false;
  }

  // Extract the content between colons
  const content = state.src.slice(start + 1, pos);

  // Check if it's a valid UUID (any version)
  if (!isUUID(content)) {
    return false;
  }

  // If we're in silent mode (checking if rule matches), just return true
  if (!silent) {
    const token = state.push("emoji", "", 0);
    token.markup = content;
    token.content = content;
  }

  state.pos = pos + 1;
  return true;
}

export default function emoji(md: MarkdownIt) {
  // Ideally this would be an empty object, but due to a bug in markdown-it-emoji
  // passing an empty object results in newlines becoming emojis. Until this is
  // fixed at least one key is required. See:
  // https://github.com/markdown-it/markdown-it-emoji/issues/46
  const noMapping = {
    no_name_mapping: "💯",
  };

  // Add the custom emoji rule first so it can catch UUID patterns
  md.inline.ruler.push("custom_emoji", customEmojiRule);

  // Apply the standard emoji plugin to handle regular emoji names
  emojiPlugin(md, {
    defs: (md.options as Options).emoji === false ? noMapping : nameToEmoji,
    shortcuts: {},
  });

  return md;
}