comark 0.0.1 → 0.1.0

package/dist/parse.js

@@ -0,0 +1,163 @@
+import MarkdownExit from 'markdown-exit';
+import pluginMdc from '@comark/markdown-it';
+import taskList from "./plugins/task-list.js";
+import alert from "./plugins/alert.js";
+import { applyAutoUnwrap } from "./internal/parse/auto-unwrap.js";
+import { marmdownItTokensToComarkTree } from "./internal/parse/token-processor.js";
+import { autoCloseMarkdown } from "./internal/parse/auto-close/index.js";
+import { parseFrontmatter } from "./internal/frontmatter.js";
+import { extractReusableNodes } from "./internal/parse/incremental.js";
+import html_block from "./internal/parse/html/html_block_rule.js";
+import html_inline from "./internal/parse/html/html_inline_rule.js";
+// Re-export frontmatter utilities
+export { parseFrontmatter } from "./internal/frontmatter.js";
+/**
+ * Creates a parser function for Comark content.
+ *
+ * Returns an async function that takes a markdown string and returns a Promise resolving to a ComarkTree AST.
+ * The returned parser applies frontmatter extraction, Comark syntax parsing, token-to-AST conversion,
+ * auto-closing of incomplete markdown, optional AST transformations and plugin hooks.
+ *
+ * @param options - Parser options controlling parsing behavior.
+ * @returns An async parser function: (markdown) => Promise<ComarkTree>
+ *
+ * @example
+ * ```typescript
+ * import { createParse } from 'comark'
+ *
+ * const parse = createParse({ autoUnwrap: false })
+ * const tree = await parse('# Hello **World**\n::alert\nhi\n::')
+ * console.log(tree.nodes)
+ * // → [ ['h1', { id: 'hello-world' }, 'Hello ', ['strong', {}, 'World'] ], ['alert', {}, 'hi'] ]
+ *
+ * // Enable HTML parsing (on by default) — HTML tags are included in the AST
+ * const parseWithHtml = createParse({ html: true })
+ * const tree2 = await parseWithHtml('<strong class="bold">Hello</strong> _world_')
+ * console.log(tree2.nodes)
+ * // → [ ['strong', { class: 'bold' }, 'Hello'], ' ', ['em', {}, 'world'] ]
+ *
+ * // Disable HTML parsing — HTML tags are treated as plain text
+ * const parseNoHtml = createParse({ html: false })
+ * ```
+ */
+export function createParse(options = {}) {
+    const { autoUnwrap = true, autoClose = true, plugins = [] } = options;
+    plugins.unshift(taskList());
+    plugins.unshift(alert());
+    const parser = new MarkdownExit({
+        html: false,
+        linkify: true,
+    })
+        .enable(['table', 'strikethrough'])
+        .use(pluginMdc);
+    if (options.html !== false) {
+        parser.inline.ruler.before('text', 'comark_html_inline', html_inline);
+        parser.block.ruler.before('html_block', 'comark_html_block', html_block, {
+            alt: ['paragraph', 'reference', 'blockquote'],
+        });
+    }
+    for (const plugin of plugins) {
+        for (const markdownItPlugin of (plugin.markdownItPlugins || [])) {
+            parser.use(markdownItPlugin);
+        }
+    }
+    let lastOutput = null;
+    let lastInput = null;
+    return async (markdown, opts = {}) => {
+        const state = {
+            options,
+            tokens: [],
+            markdown,
+            tree: null,
+            parsedLines: 0,
+            reusableNodes: [],
+        };
+        const prevOutput = lastOutput;
+        if (opts.streaming && prevOutput && markdown.startsWith(lastInput ?? '')) {
+            const { remainingMarkdownStartLine, reusedNodes, remainingMarkdown } = extractReusableNodes(markdown, prevOutput);
+            // If there is no remaining markdown, return the previous output
+            if (!remainingMarkdown)
+                return prevOutput;
+            state.parsedLines = remainingMarkdownStartLine;
+            state.markdown = remainingMarkdown;
+            state.reusableNodes = reusedNodes;
+        }
+        if (autoClose) {
+            state.markdown = autoCloseMarkdown(state.markdown);
+        }
+        for (const plugin of options.plugins || []) {
+            await plugin.pre?.(state);
+        }
+        const { content, data } = await parseFrontmatter(state.markdown);
+        state.tokens = parser.parse(content, {});
+        // Convert tokens to Comark structure
+        let nodes = marmdownItTokensToComarkTree(state.tokens, {
+            startLine: state.parsedLines,
+            preservePositions: opts.streaming ?? false,
+        });
+        if (autoUnwrap) {
+            nodes = nodes.map((node) => applyAutoUnwrap(node));
+        }
+        if (opts.streaming) {
+            state.tree = {
+                frontmatter: state.parsedLines > 0 ? (prevOutput?.frontmatter ?? data) : data,
+                meta: {},
+                nodes: [...state.reusableNodes, ...nodes],
+            };
+            // Set last output and input for streaming mode
+            lastOutput = state.tree;
+            lastInput = markdown;
+        }
+        else {
+            state.tree = {
+                frontmatter: data,
+                meta: {},
+                nodes,
+            };
+            // Reset last output and input for non-streaming mode
+            lastOutput = null;
+            lastInput = null;
+        }
+        for (const plugin of plugins || []) {
+            await plugin.post?.(state);
+        }
+        return state.tree;
+    };
+}
+/**
+ * Parse Comark content from a string
+ *
+ * @param markdown - The markdown/Comark content as a string
+ * @param options - Parser options
+ * @returns ComarkTree - The parsed AST tree
+ *
+ * @example
+ * ```typescript
+ * import { parse } from 'comark'
+ *
+ * const content = `---
+ * title: Hello World
+ * ---
+ *
+ * # Hello World
+ *
+ * This is a **markdown** document with *Comark* components.
+ *
+ * ::alert{type="info"}
+ * This is an alert component
+ * ::
+ * `
+ *
+ * const tree = await parse(content)
+ * console.log(tree.nodes)        // Array of AST nodes
+ * console.log(tree.frontmatter)  // { title: 'Hello World' }
+ * console.log(tree.meta)         // Additional metadata
+ *
+ * // Disable auto-unwrap
+ * const tree2 = await parse(content, { autoUnwrap: false })
+ * ```
+ */
+export async function parse(markdown, options = {}) {
+    const parse = createParse(options);
+    return await parse(markdown);
+}

package/dist/plugins/alert.d.ts

@@ -0,0 +1,2 @@
+import type { ComarkPlugin } from 'comark';
+export default function alert(): ComarkPlugin;

package/dist/plugins/alert.js

@@ -0,0 +1,66 @@
+import { visit } from 'comark/utils';
+const markers = {
+    '!TIP': {
+        type: 'tip',
+        title: 'Tip',
+        color: '#238636',
+    },
+    '!NOTE': {
+        type: 'note',
+        title: 'Note',
+        color: '#1f6feb',
+    },
+    '!IMPORTANT': {
+        type: 'important',
+        title: 'Important',
+        color: '#8957e5',
+    },
+    '!WARNING': {
+        type: 'warning',
+        title: 'Warning',
+        color: '#9e6a03',
+    },
+    '!CAUTION': {
+        type: 'caution',
+        title: 'Caution',
+        color: '#da3633',
+    },
+};
+export default function alert() {
+    return {
+        name: 'alert',
+        post(state) {
+            visit(state.tree, node => Array.isArray(node) && node[0] === 'blockquote', (node) => {
+                const element = node;
+                if (node[2]?.[0] === 'span') {
+                    const content = String(node[2][2]).toUpperCase();
+                    const marker = markers[content];
+                    if (marker) {
+                        if (typeof node[3] === 'string') {
+                            element[3] = String(element[3]).trimStart();
+                        }
+                        // remove span node
+                        element.splice(2, 1);
+                        element[1].as = marker.type;
+                    }
+                }
+                else if (node[2]?.[0] === 'p') {
+                    const paragraph = node[2];
+                    if (paragraph[2]?.[0] === 'span') {
+                        const content = String(paragraph[2][2]).toUpperCase();
+                        const marker = markers[content];
+                        if (marker) {
+                            if (typeof paragraph[3] === 'string') {
+                                paragraph[3] = String(paragraph[3]).trimStart();
+                            }
+                            // remove span node
+                            paragraph.splice(2, 1);
+                            // transform node
+                            element[1].as = marker.type;
+                        }
+                    }
+                }
+            });
+        },
+    };
+}

package/dist/plugins/emoji.d.ts

@@ -0,0 +1,3 @@
+import type { ComarkPlugin, MarkdownItPlugin } from 'comark';
+export declare const markdownItEmoji: MarkdownItPlugin;
+export default function comarkEmoji(): ComarkPlugin;

package/dist/plugins/emoji.js

@@ -0,0 +1,438 @@
+// Common emoji definitions (200+ emojis)
+// Organized by category for easier maintenance
+const EMOJI_MAP = new Map([
+    ['grinning', '😀'],
+    ['smiley', '😃'],
+    ['smile', '😄'],
+    ['grin', '😁'],
+    ['laughing', '😆'],
+    ['satisfied', '😆'],
+    ['sweat_smile', '😅'],
+    ['joy', '😂'],
+    ['wink', '😉'],
+    ['blush', '😊'],
+    ['innocent', '😇'],
+    ['heart_eyes', '😍'],
+    ['kissing_heart', '😘'],
+    ['kissing', '😗'],
+    ['kissing_closed_eyes', '😚'],
+    ['kissing_smiling_eyes', '😙'],
+    ['yum', '😋'],
+    ['stuck_out_tongue', '😛'],
+    ['stuck_out_tongue_winking_eye', '😜'],
+    ['stuck_out_tongue_closed_eyes', '😝'],
+    ['neutral_face', '😐'],
+    ['expressionless', '😑'],
+    ['no_mouth', '😶'],
+    ['smirk', '😏'],
+    ['unamused', '😒'],
+    ['relieved', '😌'],
+    ['pensive', '😔'],
+    ['sleepy', '😪'],
+    ['sleeping', '😴'],
+    ['mask', '😷'],
+    ['dizzy_face', '😵'],
+    ['sunglasses', '😎'],
+    ['confused', '😕'],
+    ['worried', '😟'],
+    ['open_mouth', '😮'],
+    ['hushed', '😯'],
+    ['astonished', '😲'],
+    ['flushed', '😳'],
+    ['frowning', '😦'],
+    ['anguished', '😧'],
+    ['fearful', '😨'],
+    ['cold_sweat', '😰'],
+    ['disappointed_relieved', '😥'],
+    ['cry', '😢'],
+    ['sob', '😭'],
+    ['scream', '😱'],
+    ['confounded', '😖'],
+    ['persevere', '😣'],
+    ['disappointed', '😞'],
+    ['sweat', '😓'],
+    ['weary', '😩'],
+    ['tired_face', '😫'],
+    ['triumph', '😤'],
+    ['rage', '😡'],
+    ['angry', '😠'],
+    ['smiling_imp', '😈'],
+    ['imp', '👿'],
+    ['skull', '💀'],
+    ['eyes', '👀'],
+    ['eye', '👁️'],
+    ['nose', '👃'],
+    ['lips', '👄'],
+    ['tongue', '👅'],
+    ['heart', '❤️'],
+    ['yellow_heart', '💛'],
+    ['green_heart', '💚'],
+    ['blue_heart', '💙'],
+    ['purple_heart', '💜'],
+    ['broken_heart', '💔'],
+    ['thumbsup', '👍'],
+    ['+1', '👍'],
+    ['thumbsdown', '👎'],
+    ['-1', '👎'],
+    ['ok_hand', '👌'],
+    ['facepunch', '👊'],
+    ['punch', '👊'],
+    ['fist', '✊'],
+    ['v', '✌️'],
+    ['wave', '👋'],
+    ['hand', '✋'],
+    ['raised_hand', '✋'],
+    ['clap', '👏'],
+    ['pray', '🙏'],
+    ['point_up', '☝️'],
+    ['point_down', '👇'],
+    ['point_left', '👈'],
+    ['point_right', '👉'],
+    ['raised_hands', '🙌'],
+    ['muscle', '💪'],
+    ['writing_hand', '✍️'],
+    ['nail_care', '💅'],
+    ['selfie', '🤳'],
+    ['fire', '🔥'],
+    ['sparkles', '✨'],
+    ['star', '⭐'],
+    ['star2', '🌟'],
+    ['zap', '⚡'],
+    ['boom', '💥'],
+    ['collision', '💥'],
+    ['100', '💯'],
+    ['tada', '🎉'],
+    ['confetti_ball', '🎊'],
+    ['balloon', '🎈'],
+    ['gift', '🎁'],
+    ['birthday', '🎂'],
+    ['cake', '🍰'],
+    ['rocket', '🚀'],
+    ['helicopter', '🚁'],
+    ['airplane', '✈️'],
+    ['boat', '⛵'],
+    ['ship', '🚢'],
+    ['train', '🚂'],
+    ['bus', '🚌'],
+    ['taxi', '🚕'],
+    ['car', '🚗'],
+    ['bike', '🚲'],
+    ['checkered_flag', '🏁'],
+    ['medal', '🏅'],
+    ['trophy', '🏆'],
+    ['medal_sports', '🏅'],
+    ['medal_military', '🎖️'],
+    ['soccer', '⚽'],
+    ['basketball', '🏀'],
+    ['football', '🏈'],
+    ['baseball', '⚾'],
+    ['tennis', '🎾'],
+    ['bowling', '🎳'],
+    ['golf', '⛳'],
+    ['dart', '🎯'],
+    ['beer', '🍺'],
+    ['beers', '🍻'],
+    ['wine_glass', '🍷'],
+    ['cocktail', '🍸'],
+    ['coffee', '☕'],
+    ['pizza', '🍕'],
+    ['hamburger', '🍔'],
+    ['fries', '🍟'],
+    ['apple', '🍎'],
+    ['banana', '🍌'],
+    ['watermelon', '🍉'],
+    ['grapes', '🍇'],
+    ['strawberry', '🍓'],
+    ['cherries', '🍒'],
+    ['lemon', '🍋'],
+    ['peach', '🍑'],
+    ['pear', '🍐'],
+    ['pineapple', '🍍'],
+    ['tomato', '🍅'],
+    ['eggplant', '🍆'],
+    ['hot_pepper', '🌶️'],
+    ['corn', '🌽'],
+    ['bread', '🍞'],
+    ['croissant', '🥐'],
+    ['baguette_bread', '🥖'],
+    ['cheese', '🧀'],
+    ['egg', '🥚'],
+    ['poultry_leg', '🍗'],
+    ['meat_on_bone', '🍖'],
+    ['doughnut', '🍩'],
+    ['cookie', '🍪'],
+    ['chocolate_bar', '🍫'],
+    ['candy', '🍬'],
+    ['lollipop', '🍭'],
+    ['ice_cream', '🍦'],
+    ['icecream', '🍨'],
+    ['shaved_ice', '🍧'],
+    ['tea', '🍵'],
+    ['sake', '🍶'],
+    ['champagne', '🍾'],
+    ['tropical_drink', '🍹'],
+    ['sunny', '☀️'],
+    ['cloud', '☁️'],
+    ['umbrella', '☂️'],
+    ['snowflake', '❄️'],
+    ['snowman', '⛄'],
+    ['rainbow', '🌈'],
+    ['ocean', '🌊'],
+    ['droplet', '💧'],
+    ['zap', '⚡'],
+    ['fire', '🔥'],
+    ['star', '⭐'],
+    ['moon', '🌙'],
+    ['partly_sunny', '⛅'],
+    ['thunder_cloud_and_rain', '⛈️'],
+    ['wind_face', '🌬️'],
+    ['fog', '🌫️'],
+    ['dog', '🐶'],
+    ['cat', '🐱'],
+    ['mouse', '🐭'],
+    ['rabbit', '🐰'],
+    ['fox_face', '🦊'],
+    ['bear', '🐻'],
+    ['panda_face', '🐼'],
+    ['koala', '🐨'],
+    ['tiger', '🐯'],
+    ['lion', '🦁'],
+    ['cow', '🐮'],
+    ['pig', '🐷'],
+    ['frog', '🐸'],
+    ['monkey_face', '🐵'],
+    ['see_no_evil', '🙈'],
+    ['hear_no_evil', '🙉'],
+    ['speak_no_evil', '🙊'],
+    ['chicken', '🐔'],
+    ['penguin', '🐧'],
+    ['bird', '🐦'],
+    ['baby_chick', '🐤'],
+    ['bee', '🐝'],
+    ['bug', '🐛'],
+    ['butterfly', '🦋'],
+    ['snail', '🐌'],
+    ['turtle', '🐢'],
+    ['snake', '🐍'],
+    ['lizard', '🦎'],
+    ['dragon', '🐉'],
+    ['whale', '🐳'],
+    ['dolphin', '🐬'],
+    ['fish', '🐟'],
+    ['octopus', '🐙'],
+    ['shell', '🐚'],
+    ['crab', '🦀'],
+    ['tree', '🌲'],
+    ['evergreen_tree', '🌲'],
+    ['deciduous_tree', '🌳'],
+    ['palm_tree', '🌴'],
+    ['cactus', '🌵'],
+    ['herb', '🌿'],
+    ['shamrock', '☘️'],
+    ['four_leaf_clover', '🍀'],
+    ['maple_leaf', '🍁'],
+    ['fallen_leaf', '🍂'],
+    ['leaves', '🍃'],
+    ['mushroom', '🍄'],
+    ['cherry_blossom', '🌸'],
+    ['rose', '🌹'],
+    ['hibiscus', '🌺'],
+    ['sunflower', '🌻'],
+    ['blossom', '🌼'],
+    ['bouquet', '💐'],
+    ['seedling', '🌱'],
+    ['christmas_tree', '🎄'],
+    ['santa', '🎅'],
+    ['gift_heart', '💝'],
+    ['ring', '💍'],
+    ['gem', '💎'],
+    ['bulb', '💡'],
+    ['book', '📖'],
+    ['pencil', '📝'],
+    ['memo', '📝'],
+    ['email', '✉️'],
+    ['envelope', '✉️'],
+    ['phone', '☎️'],
+    ['telephone', '☎️'],
+    ['iphone', '📱'],
+    ['camera', '📷'],
+    ['video_camera', '📹'],
+    ['tv', '📺'],
+    ['computer', '💻'],
+    ['keyboard', '⌨️'],
+    ['desktop_computer', '🖥️'],
+    ['printer', '🖨️'],
+    ['mouse', '🖱️'],
+    ['trackball', '🖲️'],
+    ['joystick', '🕹️'],
+    ['watch', '⌚'],
+    ['alarm_clock', '⏰'],
+    ['stopwatch', '⏱️'],
+    ['timer_clock', '⏲️'],
+    ['hourglass', '⌛'],
+    ['hourglass_flowing_sand', '⏳'],
+    ['satellite_antenna', '📡'],
+    ['battery', '🔋'],
+    ['electric_plug', '🔌'],
+    ['lock', '🔒'],
+    ['unlock', '🔓'],
+    ['key', '🔑'],
+    ['mag', '🔍'],
+    ['mag_right', '🔎'],
+    ['bell', '🔔'],
+    ['no_bell', '🔕'],
+    ['bookmark', '🔖'],
+    ['link', '🔗'],
+    ['wrench', '🔧'],
+    ['hammer', '🔨'],
+    ['nut_and_bolt', '🔩'],
+    ['thinking', '🤔'],
+    ['thinking_face', '🤔'],
+    ['question', '❓'],
+    ['grey_question', '❔'],
+    ['exclamation', '❗'],
+    ['grey_exclamation', '❕'],
+    ['warning', '⚠️'],
+    ['x', '❌'],
+    ['o', '⭕'],
+    ['white_check_mark', '✅'],
+    ['heavy_check_mark', '✔️'],
+    ['accept', '🉑'],
+    ['satellite', '📡'],
+    ['arrow_up', '⬆️'],
+    ['arrow_down', '⬇️'],
+    ['arrow_left', '⬅️'],
+    ['arrow_right', '➡️'],
+    ['arrow_upper_right', '↗️'],
+    ['arrow_lower_right', '↘️'],
+    ['arrow_lower_left', '↙️'],
+    ['arrow_upper_left', '↖️'],
+    ['arrow_up_down', '↕️'],
+    ['left_right_arrow', '↔️'],
+    ['arrows_counterclockwise', '🔄'],
+    ['back', '🔙'],
+    ['end', '🔚'],
+    ['on', '🔛'],
+    ['soon', '🔜'],
+    ['top', '🔝'],
+    ['red_circle', '🔴'],
+    ['blue_circle', '🔵'],
+    ['white_circle', '⚪'],
+    ['black_circle', '⚫'],
+    ['red_square', '🟥'],
+    ['blue_square', '🟦'],
+    ['white_square', '⬜'],
+    ['black_square', '⬛'],
+    ['orange_square', '🟧'],
+    ['yellow_square', '🟨'],
+    ['green_square', '🟩'],
+    ['purple_square', '🟪'],
+    ['brown_square', '🟫'],
+    ['diamond_shape_with_a_dot_inside', '💠'],
+    ['radio_button', '🔘'],
+    ['white_square_button', '🔳'],
+    ['black_square_button', '🔲'],
+    ['scissors', '✂️'],
+    ['paperclip', '📎'],
+    ['pushpin', '📌'],
+    ['round_pushpin', '📍'],
+    ['triangular_flag_on_post', '🚩'],
+    ['closed_book', '📕'],
+    ['open_book', '📖'],
+    ['green_book', '📗'],
+    ['blue_book', '📘'],
+    ['orange_book', '�orange_book'],
+    ['notebook', '📓'],
+    ['ledger', '📒'],
+    ['page_with_curl', '📃'],
+    ['scroll', '📜'],
+    ['page_facing_up', '📄'],
+    ['newspaper', '📰'],
+    ['bookmark_tabs', '📑'],
+    ['bar_chart', '📊'],
+    ['chart_with_upwards_trend', '📈'],
+    ['chart_with_downwards_trend', '📉'],
+    ['calendar', '📅'],
+    ['date', '📆'],
+    ['clipboard', '📋'],
+    ['file_folder', '📁'],
+    ['open_file_folder', '📂'],
+    ['briefcase', '💼'],
+    ['package', '📦'],
+    ['inbox_tray', '📥'],
+    ['outbox_tray', '📤'],
+    ['musical_note', '🎵'],
+    ['notes', '🎶'],
+    ['microphone', '🎤'],
+    ['headphones', '🎧'],
+    ['guitar', '🎸'],
+    ['trumpet', '🎺'],
+    ['saxophone', '🎷'],
+    ['violin', '🎻'],
+    ['drum', '🥁'],
+    ['clapper', '🎬'],
+    ['art', '🎨'],
+    ['performing_arts', '🎭'],
+    ['game_die', '🎲'],
+    ['slot_machine', '🎰'],
+]);
+/**
+ * Emoji parser for markdown-it
+ * Only supports :emoji_name: syntax (no shortcuts/emoticons)
+ * Uses Map for O(1) lookups and simple string scanning
+ */
+const emojiRule = (state, silent) => {
+    const max = state.posMax;
+    const start = state.pos;
+    // Quick check: must start with ':'
+    if (state.src.charCodeAt(start) !== 0x3A /* : */) {
+        return false;
+    }
+    // Find the closing ':'
+    let pos = start + 1;
+    while (pos < max) {
+        const code = state.src.charCodeAt(pos);
+        // Found closing ':'
+        if (code === 0x3A /* : */) {
+            const emojiName = state.src.slice(start + 1, pos);
+            // Check if this is a valid emoji
+            const emojiChar = EMOJI_MAP.get(emojiName);
+            if (emojiChar) {
+                if (!silent) {
+                    const token = state.push('emoji', '', 0);
+                    token.markup = emojiName;
+                    token.content = emojiChar;
+                }
+                state.pos = pos + 1;
+                return true;
+            }
+            // Not a valid emoji, stop searching
+            return false;
+        }
+        // Only allow word characters, digits, underscores, hyphens, and plus
+        // This matches the pattern of valid emoji names
+        if ((code >= 0x61 && code <= 0x7A) // a-z
+            || (code >= 0x41 && code <= 0x5A) // A-Z
+            || (code >= 0x30 && code <= 0x39) // 0-9
+            || code === 0x5F // _
+            || code === 0x2D // -
+            || code === 0x2B // +
+        ) {
+            pos++;
+            continue;
+        }
+        // Invalid character in emoji name
+        return false;
+    }
+    // No closing ':' found
+    return false;
+};
+export const markdownItEmoji = (md) => {
+    md.inline.ruler.before('emphasis', 'emoji', emojiRule);
+};
+export default function comarkEmoji() {
+    return {
+        name: 'emoji',
+        markdownItPlugins: [markdownItEmoji],
+    };
+}