diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index e4f39f9..d8c6dd1 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -69,18 +69,16 @@ jobs: run: pnpm --filter @ffm/linkify build:tld - name: Typecheck parser package run: pnpm --filter @ffm/parser typecheck - - name: Run parser unit tests - run: pnpm --filter @ffm/parser test:unit - name: Run FFM regression tests run: pnpm --filter @ffm/parser test:ffm - name: Run safety fixture run: pnpm --filter @ffm/parser test:safety - - name: Check Rust parser - run: | - cargo fmt --all -- --check - cargo check --workspace --all-targets --all-features - cargo clippy --workspace --all-targets --all-features -- -D warnings - cargo test --workspace --all-targets --all-features + # - name: Check Rust parser + # run: | + # cargo fmt --all -- --check + # cargo check --workspace --all-targets --all-features + # cargo clippy --workspace --all-targets --all-features -- -D warnings + # cargo test --workspace --all-targets --all-features build-markdown-playground: needs: test-markdown-parser diff --git a/crate/src/lib.rs b/crate/src/lib.rs index e0b8b28..4e0b991 100644 --- a/crate/src/lib.rs +++ b/crate/src/lib.rs @@ -190,7 +190,7 @@ mod shared_fixture { } } - // Execute one standard or FFM Markdown case against the Rust parser. + // Execute one cfm or FFM Markdown case against the Rust parser. fn execute_markdown_case(case: &MarkdownCase, ffm: bool) { let option = parser_option(case); if case.error.as_deref() == Some("invalid_nesting_depth") { @@ -230,11 +230,6 @@ mod shared_fixture { #[test] fn test_markdown() { - let standard = read_fixture::("markdown.json"); - assert_eq!(standard.schema_version, 2); - for case in &standard.cases { - execute_markdown_case(case, false); - } let ffm = read_fixture::("ffm.json"); assert_eq!(ffm.schema_version, 2); for case in &ffm.cases { diff --git a/fixture/ffm.json b/fixture/ffm.json index 60a544e..7842725 100644 --- a/fixture/ffm.json +++ b/fixture/ffm.json @@ -4,12 +4,12 @@ "cases": [ { "input": "| 属性 | 类型 | 说明 |\n| :--- | :---: | ---: |\n| name | string | 用户名 |", - "html": "\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
属性类型说明
namestring用户名
", + "html": "
属性类型说明
namestring用户名
", "plain_text": "属性\n类型\n说明\nname\nstring\n用户名" }, { "input": "| :--- | ---: |\n| Ray ID | a2c5ac427b7aa727 |\n| IP 地址 | 172.214.47.18 |", - "html": "\n\n\n\n\n\n\n\n\n\n\n
Ray IDa2c5ac427b7aa727
IP 地址172.214.47.18
", + "html": "
Ray IDa2c5ac427b7aa727
IP 地址172.214.47.18
", "plain_text": "Ray ID\na2c5ac427b7aa727\nIP 地址\n172.214.47.18" }, { @@ -34,22 +34,22 @@ }, { "input": "```quote\n## Title\n```", - "html": "
\n

Title

\n
", + "html": "

Title

", "plain_text": "Title" }, { "input": "```accordion\n**One**\nContent\n```", - "html": "
One

Content

\n
", + "html": "
One

Content

", "plain_text": "One\nContent" }, { "input": "```chain\n**[x] Done**\nBody\n```", - "html": "
Done

Body

\n
", + "html": "
Done

Body

", "plain_text": "Done\nBody" }, { "input": "```slide\nFirst\n\n---\n\nSecond\n```", - "html": "

First

\n

Second

\n
", + "html": "

First

Second

", "plain_text": "First\nSecond" }, { @@ -62,25 +62,6 @@ "html": "

[x](file:///etc/passwd)

", "plain_text": "[x](file:///etc/passwd)" }, - { - "input": "Visit fuyeor.xn--p1ai", - "html": "

Visit fuyeor.рф

", - "assert": [ - { - "path": "/0/content/1/type", - "value": "link" - }, - { - "path": "/0/content/1/url", - "value": "https://fuyeor.рф" - }, - { - "path": "/0/content/1/content/0/value", - "value": "fuyeor.рф" - } - ], - "plain_text": "Visit fuyeor.рф" - }, { "input": "1. example\n - example", "assert": [ diff --git a/fixture/markdown.json b/fixture/markdown.json deleted file mode 100644 index c987556..0000000 --- a/fixture/markdown.json +++ /dev/null @@ -1,63 +0,0 @@ -{ - "schema_version": 2, - "description": "Language-neutral standard Markdown parser fixtures.", - "cases": [ - { - "input": "## Hello **World**", - "html": "

Hello World

", - "plain_text": "Hello World" - }, - { - "input": "visit www.fuyeor.com or [click here](https://fuyeor.com)", - "html": "

visit www.fuyeor.com or click here

", - "plain_text": "visit www.fuyeor.com or click here" - }, - { - "input": "line\\\nbreak", - "html": "

line
\nbreak

", - "plain_text": "line\nbreak" - }, - { - "input": "text ", - "html": "

text <script>alert(1)</script>

", - "assert": [ - { - "path": "/0/type", - "value": "paragraph" - }, - { - "path": "/0/content/0/value", - "value": "text " - } - ], - "plain_text": "text " - }, - { - "input": "\n| title 1 | title 2 |\n|---|---|\n| content 1 | content 2 |\n", - "assert": [ - { - "path": "/0/type", - "value": "table" - }, - { - "path": "/0/header/0/type", - "value": "table_cell" - }, - { - "path": "/0/header/1/type", - "value": "table_cell" - }, - { - "path": "/0/content/0/type", - "value": "table_row" - } - ], - "plain_text": "title 1\ntitle 2\ncontent 1\ncontent 2" - }, - { - "input": "", - "html": "

<style>.x { color: red; }</style>

", - "plain_text": "" - } - ] -} diff --git a/fixture/safety.json b/fixture/safety.json index 2c5fb3a..816604a 100644 --- a/fixture/safety.json +++ b/fixture/safety.json @@ -1,5 +1,6 @@ { "schema_version": 1, + "description": "Language-neutral URL and color safety fixtures.", "links": [ { "input": "https://fuyeor.com", @@ -39,6 +40,5 @@ "input": "url(javascript:alert(1))", "valid": false } - ], - "description": "Language-neutral URL and color safety fixtures." + ] } diff --git a/package/benchmark/memory.ts b/package/benchmark/memory.ts index 5b131bb..e899b36 100644 --- a/package/benchmark/memory.ts +++ b/package/benchmark/memory.ts @@ -1,15 +1,15 @@ // @ffm/benchmark/memory.ts // pnpm -F @ffm/benchmark bench:memory // @ts-nocheck -import { createFuyeorMarkdownParser, render } from '@ffm/parser'; +import { createMarkdownParser, render } from '@ffm/parser'; import MarkdownIt from 'markdown-it'; import { marked } from 'marked'; import { social, article } from './samples'; // Polyfill for window if needed by some specific logic -if (typeof window === 'undefined') global.window = globalThis; +global.window = globalThis; -const ffm = createFuyeorMarkdownParser(); +const ffm = createMarkdownParser(); const mdIt = new MarkdownIt({ linkify: true }); const ffmIt = (content: string) => { diff --git a/package/benchmark/speed.ts b/package/benchmark/speed.ts index c143668..333c41d 100644 --- a/package/benchmark/speed.ts +++ b/package/benchmark/speed.ts @@ -2,12 +2,13 @@ // pnpm -F @ffm/benchmark bench:speed // @ts-nocheck import { run, bench, group } from 'mitata'; -import { createFuyeorMarkdownParser, render } from '@ffm/parser'; +import { createMarkdownParser, createCommonParser, render } from '@ffm/parser'; import MarkdownIt from 'markdown-it'; import { marked } from 'marked'; -import { social, article } from './samples'; +import { social, article } from './sample'; -const ffm = createFuyeorMarkdownParser(); +const ffm = createMarkdownParser(); +const ffm2 = createCommonParser(); const mdIt = new MarkdownIt({ linkify: true }); const ffmIt = (content: string) => { @@ -15,18 +16,27 @@ const ffmIt = (content: string) => { return render(ast); }; +const ffmIt2 = (content: string) => { + const ast = ffm2(content); + return render(ast); +}; + // Benchmarking Social scenario group('50 Social Post (Small/Frequent)', () => { - bench('@ffm/parser (AST)', () => ffm(social)); - bench('@ffm/parser (HTML)', () => ffmIt(social)); + bench('@ffm/parser (AST, Full)', () => ffm(social)); + bench('@ffm/parser (AST, No Extension)', () => ffm2(social)); + bench('@ffm/parser (HTML, Full)', () => ffmIt(social)); + bench('@ffm/parser (HTML, No Extension)', () => ffmIt2(social)); bench('markdown-it (HTML)', () => mdIt.render(social)); bench('marked (HTML)', () => marked.parse(social)); }); // Benchmarking Blog scenario group('20 Blog Post (Structured/Nested)', () => { - bench('@ffm/parser (AST)', () => ffm(article)); - bench('@ffm/parser (HTML)', () => ffmIt(article)); + bench('@ffm/parser (AST, No Extension)', () => ffm2(article)); + bench('@ffm/parser (AST, Full)', () => ffm(article)); + bench('@ffm/parser (HTML, No Extension)', () => ffmIt2(article)); + bench('@ffm/parser (HTML, Full)', () => ffmIt(article)); bench('markdown-it (HTML)', () => mdIt.render(article)); bench('marked (HTML)', () => marked.parse(article)); }); diff --git a/package/editor/core/src/parse/bridge.ts b/package/editor/core/src/parse/bridge.ts index c1e1830..02b6398 100644 --- a/package/editor/core/src/parse/bridge.ts +++ b/package/editor/core/src/parse/bridge.ts @@ -1,5 +1,5 @@ // @ffm/editor/src/parse/bridge.ts -import { createFuyeorMarkdownParser } from '@ffm/parser'; +import { createMarkdownParser } from '@ffm/parser'; import type { ASTNode } from '@ffm/parser'; import { nextBlockId } from '#/state/id'; import type { @@ -11,7 +11,7 @@ import type { FormatType, } from '#/state/document'; -const parse = createFuyeorMarkdownParser(); +const parse = createMarkdownParser(); type BlockContext = { listDepth: number; @@ -42,11 +42,11 @@ function collectBlock(nodeArray: ASTNode[], context: BlockContext): Block[] { switch (node.type) { case 'paragraph': case 'heading': - case 'code_block': - case 'math_block': + case 'code': + case 'math': case 'mermaid': case 'abc': - case 'smiles_block': + case 'smiles': case 'hr': blockArray.push(createLeafBlock(node, context)); break; @@ -101,12 +101,12 @@ function createLeafBlock(node: ASTNode, context: BlockContext): Block { const attr: BlockAttr = {}; if (node.type === 'heading') attr.level = typeof node.level === 'number' ? node.level : 1; - if (node.type === 'code_block' && typeof node.lang === 'string') + if (node.type === 'code' && typeof node.lang === 'string') attr.language = node.lang; if (node.type === 'mermaid') attr.language = 'mermaid'; - if (node.type === 'math_block') attr.language = 'math'; + if (node.type === 'math') attr.language = 'math'; if (node.type === 'abc') attr.language = 'abc'; - if (node.type === 'smiles_block') attr.language = 'smiles'; + if (node.type === 'smiles') attr.language = 'smiles'; if (context.quoteDepth > 0) attr.quoteDepth = context.quoteDepth; return { id, type: blockTypeFor(node.type), text, formatArray, attr }; @@ -126,7 +126,7 @@ function blockTypeFor(nodeType: string): BlockType { switch (nodeType) { case 'heading': return 'heading'; - case 'code_block': + case 'code': return 'code-block'; case 'blockquote': return 'quote'; @@ -221,7 +221,7 @@ function flattenInline(nodeArray: ASTNode[]): { text += node.value ?? ''; continue; } - if (node.type === 'hardbreak') { + if (node.type === 'break') { text += '\n'; continue; } @@ -273,7 +273,7 @@ function formatTypeFor(nodeType: string): FormatType | undefined { return 'strike'; case 'link': return 'link'; - case 'inline_code': + case 'code_inline': return 'code'; case 'math_inline': return 'code'; diff --git a/package/formatter/src/print/block.ts b/package/formatter/src/print/block.ts index 326b896..01c69ec 100644 --- a/package/formatter/src/print/block.ts +++ b/package/formatter/src/print/block.ts @@ -160,11 +160,11 @@ export function printBlockNode( return lines.map((l) => (l ? `> ${l}` : '>')).join('\n'); } - if (type === 'code_block' || type === 'code') { + if (type === 'code' || type === 'code') { return printCodeBlock(node); } - if (type === 'math_block') { + if (type === 'math') { return `$$\n${(node.value as string) ?? ''}\n$$`; } @@ -180,7 +180,7 @@ export function printBlockNode( return '---'; } - if (type === 'mermaid' || type === 'abc' || type === 'smiles_block') { + if (type === 'mermaid' || type === 'abc' || type === 'smiles') { const content = (node.value as string) ?? ''; return `\`\`\`${type}\n${content.endsWith('\n') ? content : `${content}\n`}\`\`\``; } diff --git a/package/formatter/src/print/inline.ts b/package/formatter/src/print/inline.ts index b8feea7..4ce5dee 100644 --- a/package/formatter/src/print/inline.ts +++ b/package/formatter/src/print/inline.ts @@ -46,11 +46,11 @@ export function printInlineNode( return `__${printInlineNodes(node.content, option, context)}__`; } - if (type === 'strike' || type === 'delete') { + if (type === 'strike') { return `--${printInlineNodes(node.content, option, context)}--`; } - if (type === 'code_inline' || type === 'inline_code') { + if (type === 'code_inline') { const value = node.value ?? ''; const fence = '`'.repeat(Math.max(1, longestBacktickRun(value) + 1)); return `${fence}${value}${fence}`; @@ -70,7 +70,7 @@ export function printInlineNode( return `![${alt}](${node.url ?? ''})`; } - if (type === 'hardbreak') { + if (type === 'break') { return '\n'; } diff --git a/package/parser/package.json b/package/parser/package.json index 50c1ce9..c4f44a7 100644 --- a/package/parser/package.json +++ b/package/parser/package.json @@ -7,7 +7,6 @@ "sideEffects": false, "scripts": { "test": "vitest run src/index.spec.ts", - "test:unit": "vitest run src/index.spec.ts -t \"cfm fixture\"", "test:ffm": "vitest run src/index.spec.ts -t \"ffm fixture\"", "test:safety": "vitest run src/index.spec.ts -t \"safety fixture\"", "test:compat": "vitest run src/test/index.spec.ts", @@ -17,10 +16,12 @@ "#/*": "./src/*" }, "exports": { - ".": "./src/index.ts" + ".": "./src/index.ts", + "./plugin": "./src/plugin/index.ts" }, "dependencies": { - "@ffm/linkify": "workspace:*" + "@ffm/linkify": "workspace:*", + "@fuyeor/util": "^0.1.2" }, "devDependencies": { "typescript": "^7.0.2", diff --git a/package/parser/src/core/color.ts b/package/parser/src/core/color.ts index db1ca23..169f6c3 100644 --- a/package/parser/src/core/color.ts +++ b/package/parser/src/core/color.ts @@ -3,7 +3,7 @@ const COLOR_VALUE_REGEX = /^(?:#(?:[0-9a-fA-F]{3,4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})|(?:rgb|hsl)a?\([\d\s,%.]+\))$/; -// Keep color_code values within the supported CSS color grammar. +// Keep code_color values within the supported CSS color grammar. export function isSafeColorValue(value: string): boolean { return COLOR_VALUE_REGEX.test(value); } diff --git a/package/parser/src/core/parser.ts b/package/parser/src/core/parser.ts index e7d416b..1d8068b 100644 --- a/package/parser/src/core/parser.ts +++ b/package/parser/src/core/parser.ts @@ -1,6 +1,7 @@ // @ffm/parser/src/core/parser.ts import { linkify } from '@ffm/linkify'; import { BlockState, InlineState } from './state'; +import { isSafeLinkUrl } from '#/core/url'; import type { ASTNode, ASTTransform, @@ -10,33 +11,35 @@ import type { MarkdownPlugin, MarkdownParserOption, ParserContext, + AsyncCapability, } from '#/type'; -import { isSafeLinkUrl } from '#/core/url'; -const LINKIFY_CANDIDATE_REGEX = /(?:https?:\/\/|[A-Za-z0-9-]+\.)/u; +const linkRegex = /(?:https?:\/\/|[A-Za-z0-9-]+\.)/u; /** Skip linkify scans for text without a possible URL candidate. */ function linkifyWithCandidateCheck(text: string): ReturnType { - if (!LINKIFY_CANDIDATE_REGEX.test(text)) return []; + if (!linkRegex.test(text)) return []; return linkify(text); } export class MarkdownParser { - #blockRuleMap = new Map(); - #inlineRuleMap = new Map(); + readonly #maxNestingDepth: number; + readonly #linkifier: Linkifier; + #astTransforms: ASTTransform[] = []; #idSequence = 0; #isPreflight = false; - readonly #maxNestingDepth: number; - readonly #linkifier: Linkifier; + #blockRuleMap = new Map(); + #inlineRuleMap = new Map(); + #capability = new Set(); - constructor(options: MarkdownParserOption = {}) { - const maxNestingDepth = options.maxNestingDepth ?? 64; + constructor(option: MarkdownParserOption = {}) { + const maxNestingDepth = option.maxNestingDepth ?? 64; if (!Number.isInteger(maxNestingDepth) || maxNestingDepth < 1) throw new RangeError('maxNestingDepth must be a positive integer'); this.#maxNestingDepth = maxNestingDepth; - this.#linkifier = options.linkifier ?? linkifyWithCandidateCheck; + this.#linkifier = option.linkifier ?? linkifyWithCandidateCheck; } // construct a context for recursive rule calls @@ -79,17 +82,28 @@ export class MarkdownParser { return this; } - use(plugin: MarkdownPlugin): this { - plugin(this); + // Declare an external capability consumed by this parser's HTML output. + requireCapability(capability: AsyncCapability): this { + this.#capability.add(capability); return this; } + // Expose declared capabilities so hosts can drive preload / hydration. + getRequiredCapability(): ReadonlySet { + return this.#capability; + } + // Register a post-parse AST transform for extensions such as Twemoji. addAstTransform(transform: ASTTransform): this { this.#astTransforms.push(transform); return this; } + use(plugin: MarkdownPlugin): this { + plugin(this); + return this; + } + build(): (content: string) => ASTNode[] { return (content: string) => { this.#idSequence = 0; @@ -195,9 +209,9 @@ export class MarkdownParser { 'hr', 'blockquote', 'list', - 'code_block', - 'math_block', - 'ffm_blocks', + 'code', + 'math', + 'ffm', ].includes(rule.name) ) { this.#isPreflight = true; @@ -303,7 +317,7 @@ export class MarkdownParser { // normal characters without matching rules, just advance if (char === '\n') { flushText(state.pos); - nodes.push({ type: 'hardbreak' }); + nodes.push({ type: 'break' }); state.advance(1); textStart = state.pos; continue; diff --git a/package/parser/src/core/plain-text.ts b/package/parser/src/core/plain-text.ts index 231fc1d..8df3af2 100644 --- a/package/parser/src/core/plain-text.ts +++ b/package/parser/src/core/plain-text.ts @@ -10,10 +10,10 @@ export function toPlainText(node: readonly ASTNode[]): string { function blockText(node: ASTNode): string { switch (node.type) { case 'text': - case 'inline_code': - case 'color_code': + case 'code_inline': + case 'code_color': return node.value ?? ''; - case 'code_block': + case 'code': return node.value ?? ''; case 'heading': case 'paragraph': @@ -47,7 +47,7 @@ function blockText(node: ASTNode): string { } case 'table_row': return joinNodes(node.content ?? []); - case 'hardbreak': + case 'break': return '\n'; case 'hr': return ''; diff --git a/package/parser/src/core/render.ts b/package/parser/src/core/render.ts index ebce92e..d8f7474 100644 --- a/package/parser/src/core/render.ts +++ b/package/parser/src/core/render.ts @@ -1,234 +1,279 @@ // @ffm/parser/src/core/render.ts -import type { ASTNode } from '#/type'; -import { isSafeColorValue } from '#/core/color'; -import { isSafeLinkUrl } from '#/core/url'; - -const escapeHtml = (str: string) => - str.replace( - /[&<>"']/g, - (m) => - ({ - '&': '&', - '<': '<', - '>': '>', - '"': '"', - "'": ''', - })[m]!, - ); +import { escapeHtml } from '@fuyeor/util'; +import type { + ASTNode, + NodeRenderer, + RenderContext, + RenderOption, +} from '#/type'; + +// 渲染子节点;缺省时返回空串 +const content = (node: ASTNode, ctx: RenderContext): string => + ctx.render(node.content ?? []); + +// 读取纯文本值;解析器保证 value 为 string +const raw = (node: ASTNode): string => node.value ?? ''; + +// 读取并转义的纯文本值 +const rawText = (node: ASTNode): string => escapeHtml(raw(node)); -// Keep dynamic HTML tag names and CSS values within their supported grammar. -const getHeadingLevel = (level: unknown) => - typeof level === 'number' && - Number.isInteger(level) && - level >= 1 && - level <= 6 - ? level - : null; - -// Keep table alignment attributes within the supported HTML grammar. -const getTableAlignment = (align: unknown) => - align === 'left' || align === 'center' || align === 'right' +// 未知或降级节点的统一出口 +const passthrough = (node: ASTNode, ctx: RenderContext): string => + `${content(node, ctx)}`; + +// 表格单元格对齐:与 Vue renderer 的 align 属性保持一致 +const alignAttr = (cell: ASTNode): string => { + const align = cell.align; + return align === 'left' || align === 'center' || align === 'right' ? ` align="${align}"` : ''; +}; + +const renderTableCell = ( + tag: 'th' | 'td', + cell: ASTNode, + ctx: RenderContext, +): string => `<${tag}${alignAttr(cell)}>${content(cell, ctx)}`; -const displayLanguageNames: Record = { - javascript: 'JavaScript', - typescript: 'TypeScript', - cpp: 'C++', - csharp: 'C#', - xml: 'XML', - json: 'JSON', - yaml: 'YAML', - ffm: 'Fuyeor Flavored Markdown', - fon: 'FON', - fer: 'Fer', +const renderTableHead = ( + cells: ASTNode[] | undefined, + ctx: RenderContext, +): string => { + if (!cells?.length) return ''; + const rows = cells.map((cell) => renderTableCell('th', cell, ctx)).join(''); + return `${rows}`; }; -// Render a stable fenced-code contract for asynchronous highlight.js processing. -const getCodeLanguage = (lang: unknown): string => { - if (typeof lang !== 'string') return ''; - return lang.trim().split(/\s+/u)[0] ?? ''; +const renderTableBody = ( + rows: ASTNode[] | undefined, + ctx: RenderContext, +): string => { + if (!rows?.length) return ''; + const body = rows + .map((row) => { + const cells = (row.content ?? []) + .map((cell) => renderTableCell('td', cell, ctx)) + .join(''); + return `${cells}`; + }) + .join(''); + return `${body}`; }; -const getDisplayLanguageName = (language: string): string => - displayLanguageNames[language] ?? - (language ? language.charAt(0).toUpperCase() + language.slice(1) : 'Text'); +// 渲染标题;level 由解析器保证为 1..6 +const renderHeading = (node: ASTNode, ctx: RenderContext): string => { + const level = node.level; + return `${content(node, ctx)}`; +}; -export function render(nodes?: ASTNode[]): string { - let html = ''; +// 渲染代码块:结构与 Vue renderer 输出对齐 +const renderCodeBlock = (node: ASTNode): string => { + const language = node.lang ?? ''; + const value = rawText(node); + const body = language + ? `
${escapeHtml(language)}
` + + `
${value}
` + : `
${value}
`; + return `
${body}
`; +}; - if (!nodes || nodes.length === 0) return ''; +// 渲染颜色代码块;color_code 由 inlineCodeRule 生成,value 已通过颜色语法校验 +const renderCodeColor = (node: ASTNode): string => { + const color = escapeHtml(raw(node)); + const style = + 'display:inline-block;width:0.8em;height:0.8em;border-radius:50%;' + + `background-color:${color};vertical-align:middle;margin-right:0.3em;` + + 'border:1px solid #00000030;'; + return ( + `` + + `${color}` + + `` + ); +}; - for (const node of nodes) { - switch (node.type) { - case 'heading': { - const level = getHeadingLevel(node.level); - html += - level === null - ? `${render(node.content)}` - : `${render(node.content)}\n`; - break; - } - case 'paragraph': - html += `

${render(node.content)}

\n`; - break; - case 'text': - html += node.value ? escapeHtml(node.value) : ''; - break; - case 'emoji': { - const emoji = String(node.value ?? ''); - const alt = String(node.alt ?? emoji); - const src = String(node.src ?? ''); - html += `${escapeHtml(alt)}`; - break; - } - case 'math_inline': - html += `${escapeHtml(String(node.value ?? ''))}`; - break; - case 'math_block': - html += `
${escapeHtml(String(node.value ?? ''))}
\n`; - break; - case 'bold': - html += `${render(node.content)}`; - break; - case 'italic': - html += `${render(node.content)}`; - break; - case 'underline': - html += `${render(node.content)}`; - break; - case 'strike': - html += `${render(node.content)}`; - break; - case 'inline_code': - html += `${node.value ? escapeHtml(node.value) : ''}`; - break; - case 'color_code': { - const color = String(node.value ?? ''); - if (!isSafeColorValue(color)) { - html += escapeHtml(color); - break; +// 渲染链接;linkRule / linkify 已过滤 URL scheme +const renderLink = (node: ASTNode, ctx: RenderContext): string => { + const url = escapeHtml((node.url ?? '').trim()); + return `${content(node, ctx)}`; +}; + +// 渲染图片;url 由解析器过滤 scheme,alt / caption 为纯文本 +const renderImage = (node: ASTNode, ctx: RenderContext): string => { + const url = escapeHtml((node.url ?? '').trim()); + const img = `${node.alt}`; + + // caption 与 title 等价;缺省时退化为裸 + const caption = node.caption ?? node.title; + if (!caption || (Array.isArray(caption) && caption.length === 0)) return img; + + const figcaption = + typeof caption === 'string' ? escapeHtml(caption) : ctx.render(caption); + + return ( + `
` + + img + + `
${figcaption}
` + + `
` + ); +}; + +// 链节点状态类名;与 Vue renderer 保持一致 +const chainStatusClass = (node: ASTNode): string => + node.hasCheckbox ? (node.isCompleted ? 'is-completed' : 'is-pending') : ''; + +// 渲染 AST 为 HTML;custom 渲染器按节点类型覆盖内置分支 +export function render(nodeArray?: ASTNode[], option?: RenderOption): string { + const custom = option?.nodeRenderer; + const ctx: RenderContext = { + escapeHtml, + render: (children) => renderNodes(children, custom, ctx), + }; + return renderNodes(nodeArray, custom, ctx); +} + +function renderNodes( + nodeArray: ASTNode[] | undefined, + custom: Record | undefined, + ctx: RenderContext, +): string { + if (!nodeArray?.length) return ''; + + return nodeArray + .map((node) => { + const renderer = custom?.[node.type]; + if (renderer) return renderer(node, ctx); + + switch (node.type) { + // Common Flavored Markdown + case 'heading': + return renderHeading(node, ctx); + case 'paragraph': + return `

${content(node, ctx)}

`; + case 'text': + return rawText(node); + case 'bold': + return `${content(node, ctx)}`; + case 'italic': + return `${content(node, ctx)}`; + case 'underline': + return `${content(node, ctx)}`; + case 'strike': + return `${content(node, ctx)}`; + case 'link': + return renderLink(node, ctx); + case 'image': + return renderImage(node, ctx); + case 'hr': + return '
'; + case 'break': + return '
'; + case 'blockquote': + return `
${content(node, ctx)}
`; + + case 'code': + return renderCodeBlock(node); + case 'code_inline': + return `${rawText(node)}`; + case 'code_color': + return renderCodeColor(node); + + case 'list': { + const tag = node.ordered ? 'ol' : 'ul'; + const start = + node.ordered && node.start && node.start !== 1 + ? ` start="${node.start}"` + : ''; + return `<${tag}${start}>${content(node, ctx)}`; } - html += `${escapeHtml(color)}`; - break; - } - case 'link': { - const url = String(node.url ?? '').trim(); - html += isSafeLinkUrl(url) - ? `${render(node.content)}` - : render(node.content); - break; - } - case 'code_block': { - const language = getCodeLanguage(node.lang); - const displayLanguage = getDisplayLanguageName(language); - const preAttributes = language - ? `class="hljs language-${escapeHtml(language)}" data-language="${escapeHtml(language)}"` - : 'class="hljs language-plaintext"'; - html += `
`; - if (language) { - html += `
${escapeHtml(displayLanguage)}
`; + case 'list_item': + return `
  • ${content(node, ctx)}
  • `; + + case 'table': { + const head = renderTableHead(node.header, ctx); + const body = renderTableBody(node.content, ctx); + return `
    ${head}${body}
    `; } - html += `
    ${escapeHtml(String(node.value ?? ''))}\n
    \n`; - break; - } - case 'list': { - const tag = node.ordered ? 'ol' : 'ul'; - const start = - node.ordered && node.start && node.start !== 1 - ? ` start="${node.start}"` + + // Fuyeor Flavored Markdown + case 'accordion': + return `
    ${content(node, ctx)}
    `; + case 'accordion_item': { + const name = node.name ? ` name="${escapeHtml(node.name)}"` : ''; + return ( + `` + + `${ctx.render(node.title ?? [])}` + + `
    ${content(node, ctx)}
    ` + + `` + ); + } + + case 'chain': + return `
    ${content(node, ctx)}
    `; + case 'chain_item': { + const status = chainStatusClass(node); + const titleNodes = node.title; + const title = titleNodes?.length + ? `
    ${ctx.render(titleNodes)}
    ` : ''; - html += `<${tag}${start}>\n${render(node.content)}\n`; - break; - } - case 'list_item': - html += `
  • ${render(node.content)}
  • \n`; - break; - case 'mermaid': - html += `
    ${escapeHtml(String(node.value ?? ''))}
    \n`; - break; - case 'abc': - html += `
    ${escapeHtml(String(node.value ?? ''))}
    \n`; - break; - case 'smiles_inline': - html += ``; - break; - case 'smiles_block': { - const blocks = String(node.value ?? '') - .split('\n') - .filter((line) => line.trim().length > 0) - .map( - (line) => - `
    `, + return ( + `
    ` + + `
    ` + + `
    ${title}` + + `
    ${content(node, ctx)}
    ` + + `
    ` ); - html += blocks.length > 0 ? `${blocks.join('\n')}\n` : ''; - break; - } - case 'table': { - html += '\n'; - if (node.header) { - html += '\n\n'; - node.header.forEach((cell) => { - html += `${render(cell.content)}\n`; - }); - html += '\n\n'; } - if (node.content && node.content.length > 0) { - html += '\n'; - node.content.forEach((row) => { - html += '\n'; - row.content?.forEach((cell) => { - html += `${render(cell.content)}\n`; - }); - html += '\n'; - }); - html += '\n'; + + case 'slide': + return ( + `
    ` + + `
    ${content(node, ctx)}
    ` + + `
    ` + ); + case 'slide_item': + return `
    ${content(node, ctx)}
    `; + + // 异步节点:属性与 Vue renderer 输出完全对齐,供 hydrate() 扫描 + case 'emoji': { + const alt = node.value ?? ''; + const src = String(node.src ?? ''); + return ( + `${escapeHtml(alt)}` + ); } - html += '
    \n'; - break; - } - case 'hr': - html += '
    \n'; - break; - case 'blockquote': - html += `
    \n${render(node.content)}
    \n`; - break; - case 'accordion': - html += `
    ${render(node.content)}
    `; - break; - case 'accordion_item': - html += `
    ${render(node.title)}
    ${render(node.content)}
    `; - break; - case 'chain': - html += `
    ${render(node.content)}
    `; - break; - case 'chain_item': { - const statusClass = node.hasCheckbox - ? node.isCompleted - ? 'is-completed' - : 'is-pending' - : ''; - const title = - node.title && node.title.length > 0 - ? `
    ${render(node.title)}
    ` - : ''; - html += `
    ${title}
    ${render(node.content)}
    `; - break; + + case 'math': + return `
    ${rawText(node)}
    `; + case 'math_inline': + return `${rawText(node)}`; + + case 'mermaid': + return `
    ${rawText(node)}
    `; + + case 'smiles': { + const lines = raw(node) + .split('\n') + .map((line) => line.trim()) + .filter((line) => line.length > 0); + if (lines.length === 0) return ''; + const blocks = lines + .map( + (line) => + `
    `, + ) + .join(''); + return `${blocks}`; + } + case 'smiles_inline': + return ``; + + case 'abc': + return `
    ${rawText(node)}
    `; + + default: + return passthrough(node, ctx); } - case 'slide': - html += `
    ${render(node.content)}
    `; - break; - case 'slide_item': - html += `
    ${render(node.content)}
    `; - break; - case 'hardbreak': - html += '
    \n'; - break; - default: - html += `${render(node.content)}`; - break; - } - } - - return html; + }) + .join(''); } diff --git a/package/parser/src/default.ts b/package/parser/src/default.ts index f258866..5ca1b68 100644 --- a/package/parser/src/default.ts +++ b/package/parser/src/default.ts @@ -1,6 +1,5 @@ // @ffm/parser/src/default.ts import { MarkdownParser } from './core/parser'; -import type { MarkdownParserOption } from './type'; import { headingRule, tableRule, @@ -10,58 +9,68 @@ import { blockquoteRule, } from './rule/block'; import { - hardBreakRule, inlineCodeRule, linkRule, + imageRule, boldRule, underlineRule, italicRule, strikeRule, } from './rule/inline'; import { ffmBlockRule } from './rule/ffm'; +import type { MarkdownParserOption } from './type'; + +import { twemojiPlugin } from './plugin/twemoji'; +import { highlightPlugin } from './plugin/highlight'; import { latexPlugin } from './plugin/latex'; -import { extensionsPlugin } from './plugin/extensions'; +import { mermaidPlugin } from './plugin/mermaid'; +import { smilesPlugin } from './plugin/smiles'; +import { abcPlugin } from './plugin/abc'; export function createMarkdownParser(option: MarkdownParserOption = {}) { return ( new MarkdownParser(option) // block order: Code block -> List -> Title -> Table -> Delete line -> Quote + .addBlockRule(ffmBlockRule) .addBlockRule(codeBlockRule) .addBlockRule(listRule) .addBlockRule(headingRule) .addBlockRule(tableRule) .addBlockRule(hrRule) .addBlockRule(blockquoteRule) - // inline order: Inline code -> Links -> Bold/Underline/Strikethrough - .addInlineRule(hardBreakRule) .addInlineRule(inlineCodeRule) + .addInlineRule(imageRule) .addInlineRule(linkRule) .addInlineRule(boldRule) .addInlineRule(underlineRule) .addInlineRule(italicRule) .addInlineRule(strikeRule) - + // plugin + .use(twemojiPlugin) + .use(latexPlugin) + .use(mermaidPlugin) + .use(smilesPlugin) + .use(abcPlugin) + // NOTE: Must be last. It capitalizes lang + // breaking plugins that match lowercase names + .use(highlightPlugin) + // generate AST node .build() ); } -export function createFuyeorMarkdownParser(option: MarkdownParserOption = {}) { +export function createCommonParser(option: MarkdownParserOption = {}) { return ( new MarkdownParser(option) // block order: Code block -> List -> Title -> Table -> Delete line -> Quote - .addBlockRule(ffmBlockRule) .addBlockRule(codeBlockRule) .addBlockRule(listRule) .addBlockRule(headingRule) .addBlockRule(tableRule) .addBlockRule(hrRule) .addBlockRule(blockquoteRule) - .use(latexPlugin) - .use(extensionsPlugin) - // inline order: Inline code -> Links -> Bold/Underline/Strikethrough - .addInlineRule(hardBreakRule) .addInlineRule(inlineCodeRule) .addInlineRule(linkRule) .addInlineRule(boldRule) diff --git a/package/parser/src/index.spec.ts b/package/parser/src/index.spec.ts index 0d72632..1f1c2f3 100644 --- a/package/parser/src/index.spec.ts +++ b/package/parser/src/index.spec.ts @@ -1,13 +1,16 @@ // @ffm/parser/src/index.spec.ts -import { readFileSync } from 'node:fs'; -import { resolve } from 'node:path'; +// @vitest-environment jsdom +// pnpm -F @ffm/parser test import { describe, expect, it } from 'vitest'; import { isSafeColorValue } from './core/color'; import { MarkdownParser } from './core/parser'; import { isSafeLinkUrl } from './core/url'; import { render } from './core/render'; import { toPlainText } from './core/plain-text'; -import { createFuyeorMarkdownParser, createMarkdownParser } from './default'; +import { createMarkdownParser, createCommonParser } from './default'; + +import ffm from '../../../fixture/ffm.json' with { type: 'json' }; +import safety from '../../../fixture/safety.json' with { type: 'json' }; type MarkdownAssertion = { path: string; @@ -31,26 +34,6 @@ type MarkdownFixtureFile = { cases: MarkdownCase[]; }; -type SafetyCase = { input: string; valid: boolean }; -type SafetyFixtureFile = { - schema_version: number; - description: string; - links: SafetyCase[]; - colors: SafetyCase[]; -}; - -const loadJson = (name: string): T => - JSON.parse( - readFileSync( - resolve(import.meta.dirname, `../../../fixture/${name}`), - 'utf8', - ), - ) as T; - -const cfmFixture = loadJson('markdown.json'); -const ffmFixture = loadJson('ffm.json'); -const safetyFixtures = loadJson('safety.json'); - // Read a portable JSON Pointer path from a TypeScript AST value. function readJsonPointer(root: unknown, pointer: string): unknown { let value = root; @@ -85,8 +68,8 @@ function executeMarkdownCase(fixture: MarkdownCase, ffm: boolean): void { } const parser = ffm - ? createFuyeorMarkdownParser(option) - : createMarkdownParser(option); + ? createMarkdownParser(option) + : createCommonParser(option); const ast = parser(fixture.input ?? ''); if (fixture.html !== undefined) expect(render(ast).trim()).toBe(fixture.html); if (fixture.plain_text !== undefined) @@ -120,8 +103,8 @@ function executeMarkdownSuite( }); } -executeMarkdownSuite('cfm fixture', cfmFixture, false); -executeMarkdownSuite('ffm fixture', ffmFixture, true); +// @ts-ignore +executeMarkdownSuite('ffm fixture', ffm, true); // Verify the public AST shape uses the modern scalar and structural field names. describe('AST field names', () => { @@ -160,11 +143,11 @@ describe('AST field names', () => { }); describe('safety fixture', () => { - expect(safetyFixtures.schema_version).toBe(1); - for (const fixture of safetyFixtures.links) + expect(safety.schema_version).toBe(1); + for (const fixture of safety.links) it(`link: ${fixture.input}`, () => expect(isSafeLinkUrl(fixture.input)).toBe(fixture.valid)); - for (const fixture of safetyFixtures.colors) + for (const fixture of safety.colors) it(`color: ${fixture.input}`, () => expect(isSafeColorValue(fixture.input)).toBe(fixture.valid)); }); diff --git a/package/parser/src/index.ts b/package/parser/src/index.ts index dc0c346..e5db33f 100644 --- a/package/parser/src/index.ts +++ b/package/parser/src/index.ts @@ -13,39 +13,14 @@ export { blockquoteRule, } from './rule/block'; export { - hardBreakRule, inlineCodeRule, boldRule, linkRule, + imageRule, underlineRule, strikeRule, } from './rule/inline'; -export { latexPlugin, latexInlineRule, latexBlockRule } from './plugin/latex'; -export { - twemojiPlugin, - nativeEmojiPlugin, - twemojiTransform, - transformTwemojiNode, - getTwemojiUrl, -} from './plugin/twemoji'; -export { highlightPlugin, highlightTransform } from './plugin/highlight'; -export { - abcPlugin, - abcTransform, - mermaidPlugin, - mermaidTransform, - smilesBlockPlugin, - smilesBlockTransform, - smilesInlinePlugin, - smilesPlugin, - smilesInlineRule, - SPECIAL_BLOCK_LANGUAGES, - specialBlockPlugin, - specialBlockTransform, - transformSpecialBlockNode, -} from './plugin/async-blocks'; -export { extensionsPlugin, extensionsTransform } from './plugin/extensions'; -export { createMarkdownParser, createFuyeorMarkdownParser } from './default'; +export { createMarkdownParser, createCommonParser } from './default'; export type { NodeType, @@ -56,5 +31,11 @@ export type { InlineRule, Linkifier, MarkdownParserOption, + NodeRenderer, + RenderContext, + RenderOption, MarkdownPlugin, + AsyncCapability, + AsyncRenderer, + HydrateOption, } from './type'; diff --git a/package/parser/src/plugin/abc/index.ts b/package/parser/src/plugin/abc/index.ts new file mode 100644 index 0000000..0df01aa --- /dev/null +++ b/package/parser/src/plugin/abc/index.ts @@ -0,0 +1,41 @@ +// @ffm/parser/src/plugin/abc.ts +import { loadScript } from '@fuyeor/util'; +import { createCodeBlockTransform } from '#/plugin/ast'; +import type { AsyncRenderer, MarkdownPlugin } from '#/type'; +import type { Abc, AbcSource } from './type'; + +// Extend the Window interface to include our highlight property +declare global { + interface Window { + // ABCJS 硬编码 `window.ABCJS` + ABCJS?: Abc; + } +} + +// Build an ABCJS renderer for fenced abc blocks. +export const createAbc = (source: AbcSource): AsyncRenderer => ({ + name: 'abc', + selector: '[data-async="abc"]', + style: source.style, + load: () => loadScript(source.script, 'ABCJS'), + render(element, abcjs) { + const code = element.textContent ?? ''; + if (!code.trim()) return; + element.textContent = ''; + abcjs.renderAbc(element, code, { + responsive: 'resize', + add_classes: true, + paddingbottom: 0, + paddingtop: 0, + paddingleft: 0, + paddingright: 0, + }); + }, +}); + +export const abcTransform = createCodeBlockTransform('abc'); + +export const abcPlugin: MarkdownPlugin = (parser) => { + parser.addAstTransform(abcTransform); + parser.requireCapability('abc'); +}; diff --git a/package/parser/src/plugin/abc/type.ts b/package/parser/src/plugin/abc/type.ts new file mode 100644 index 0000000..4e60a66 --- /dev/null +++ b/package/parser/src/plugin/abc/type.ts @@ -0,0 +1,22 @@ +// @ffm/parser/src/plugin/abc/type.ts + +// 定义 abcjs 的最小化接口类型 +export interface Abc { + renderAbc( + element: HTMLElement, + code: string, + option: { + responsive: string; + add_classes: boolean; + paddingbottom: number; + paddingtop: number; + paddingleft: number; + paddingright: number; + }, + ): void; +} + +export interface AbcSource { + script: string; + style?: readonly string[]; +} diff --git a/package/parser/src/plugin/ast.ts b/package/parser/src/plugin/ast.ts index 781dce1..d938eac 100644 --- a/package/parser/src/plugin/ast.ts +++ b/package/parser/src/plugin/ast.ts @@ -1,37 +1,66 @@ // @ffm/parser/src/plugin/ast.ts -import type { ASTNode } from '#/type'; +import type { ASTNode, ASTTransform } from '#/type'; type ASTNodeReplacement = ASTNode | readonly ASTNode[]; +const isNodeArray = (r: ASTNodeReplacement): r is readonly ASTNode[] => + Array.isArray(r); + // Recursively transform only changed branches and preserve unchanged node arrays. -export const mapAstNodes = ( - nodes: ASTNode[], +export const mapAstNode = ( + nodeArray: ASTNode[], transformNode: (node: ASTNode) => ASTNodeReplacement, ): ASTNode[] => { - let transformedNodes: ASTNode[] | undefined; + let newNodeArray: ASTNode[] | undefined; + + for (let index = 0; index < nodeArray.length; index++) { + const node = nodeArray[index]; + const content = node.content; + + const transformedChild = content?.length + ? mapAstNode(content, transformNode) + : content; - for (let index = 0; index < nodes.length; index++) { - const node = nodes[index]; - const transformedChildren = node.content - ? mapAstNodes(node.content, transformNode) - : node.content; const transformedNode = - transformedChildren && transformedChildren !== node.content - ? { ...node, content: transformedChildren } + transformedChild !== content + ? { ...node, content: transformedChild } : node; + const replacement = transformNode(transformedNode); - const replacementNodes = Array.isArray(replacement) - ? replacement - : [replacement]; - - if ( - !transformedNodes && - (replacementNodes.length !== 1 || replacementNodes[0] !== node) - ) { - transformedNodes = nodes.slice(0, index); + + if (isNodeArray(replacement)) { + if ( + !newNodeArray && + (replacement.length !== 1 || replacement[0] !== node) + ) { + newNodeArray = nodeArray.slice(0, index); + } + + if (newNodeArray) { + for (let i = 0; i < replacement.length; i++) { + newNodeArray.push(replacement[i]); + } + } + } else { + if (!newNodeArray && replacement !== node) { + newNodeArray = nodeArray.slice(0, index); + } + + if (newNodeArray) { + newNodeArray.push(replacement); + } } - transformedNodes?.push(...replacementNodes); } - return transformedNodes ?? nodes; + return newNodeArray ?? nodeArray; }; + +// 将指定语言的代码块,声明式映射为目标 AST 节点 +export const createCodeBlockTransform = + (language: string, targetType = language): ASTTransform => + (nodeArray) => + mapAstNode(nodeArray, (node) => + node.type === 'code' && node.lang === language + ? { type: targetType, value: String(node.value ?? '') } + : node, + ); diff --git a/package/parser/src/plugin/async-blocks.ts b/package/parser/src/plugin/async-blocks.ts deleted file mode 100644 index 6145159..0000000 --- a/package/parser/src/plugin/async-blocks.ts +++ /dev/null @@ -1,89 +0,0 @@ -// @ffm/parser/src/plugin/async-blocks.ts -import { InlineState } from '#/core/state'; -import type { ASTNode, ASTTransform, InlineRule, MarkdownPlugin } from '#/type'; -import { mapAstNodes } from './ast'; -import { normalizeHighlightLanguage } from './highlight'; - -const SMILES_INLINE_PATTERN = /^#\[smiles\s*=\s*`([^`]+)`\]/u; -export const SPECIAL_BLOCK_LANGUAGES = new Set(['mermaid', 'abc', 'smiles']); - -// Parse the FFM #[smiles = `...`] inline placeholder syntax. -export const smilesInlineRule: InlineRule = { - name: 'smiles_inline', - marker: ['#'], - parse(state: InlineState) { - if (state.currentChar !== '#') return null; - - const match = state.content.slice(state.pos).match(SMILES_INLINE_PATTERN); - if (!match) return null; - - return { - node: { type: 'smiles_inline', value: match[1].trim() }, - consumedChars: match[0].length, - }; - }, -}; - -// Convert one fenced code block into its asynchronous renderer placeholder. -export const transformSpecialBlockNode = ( - node: ASTNode, - languages: ReadonlySet, -): ASTNode => { - if (node.type !== 'code_block') return node; - - const language = normalizeHighlightLanguage(String(node.lang ?? '')); - if (!languages.has(language)) return node; - - return { - type: language === 'smiles' ? 'smiles_block' : language, - value: String(node.value ?? ''), - } satisfies ASTNode; -}; - -// Build a lazy transform for a selected set of special fenced languages. -const createSpecialBlockTransform = - (languages: ReadonlySet): ASTTransform => - (nodes) => - mapAstNodes(nodes, (node) => transformSpecialBlockNode(node, languages)); - -export const mermaidTransform = createSpecialBlockTransform( - new Set(['mermaid']), -); -export const abcTransform = createSpecialBlockTransform(new Set(['abc'])); -export const smilesBlockTransform = createSpecialBlockTransform( - new Set(['smiles']), -); -export const specialBlockTransform = createSpecialBlockTransform( - SPECIAL_BLOCK_LANGUAGES, -); - -// Register Mermaid, ABC, and fenced Smiles block placeholders together. -export const specialBlockPlugin: MarkdownPlugin = (parser) => { - parser.addAstTransform(specialBlockTransform); -}; - -// Register only Mermaid fenced blocks for consumers that opt in selectively. -export const mermaidPlugin: MarkdownPlugin = (parser) => { - parser.addAstTransform(mermaidTransform); -}; - -// Register only ABC fenced blocks for consumers that opt in selectively. -export const abcPlugin: MarkdownPlugin = (parser) => { - parser.addAstTransform(abcTransform); -}; - -// Register only fenced Smiles blocks for consumers that opt in selectively. -export const smilesBlockPlugin: MarkdownPlugin = (parser) => { - parser.addAstTransform(smilesBlockTransform); -}; - -// Register the FFM inline Smiles syntax. -export const smilesInlinePlugin: MarkdownPlugin = (parser) => { - parser.addInlineRule(smilesInlineRule); -}; - -// Register both inline and fenced Smiles syntax. -export const smilesPlugin: MarkdownPlugin = (parser) => { - smilesInlinePlugin(parser); - smilesBlockPlugin(parser); -}; diff --git a/package/parser/src/plugin/extensions.ts b/package/parser/src/plugin/extensions.ts deleted file mode 100644 index 400f131..0000000 --- a/package/parser/src/plugin/extensions.ts +++ /dev/null @@ -1,32 +0,0 @@ -// @ffm/parser/src/plugin/extensions.ts -import type { ASTNode, ASTTransform, MarkdownPlugin } from '#/type'; -import { mapAstNodes } from './ast'; -import { transformTwemojiNode } from './twemoji'; -import { - SPECIAL_BLOCK_LANGUAGES, - transformSpecialBlockNode, - smilesInlinePlugin, -} from './async-blocks'; -import { normalizeHighlightLanguage } from './highlight'; - -// Normalize code languages and special blocks in the same pass as Twemoji. -const transformExtensionNode = ( - node: ASTNode, -): ASTNode | readonly ASTNode[] => { - if (node.type === 'text') return transformTwemojiNode(node); - if (node.type !== 'code_block') return node; - - const language = normalizeHighlightLanguage(String(node.lang ?? '')); - const normalizedNode = - language && language !== node.lang ? { ...node, lang: language } : node; - return transformSpecialBlockNode(normalizedNode, SPECIAL_BLOCK_LANGUAGES); -}; - -export const extensionsTransform: ASTTransform = (nodes) => - mapAstNodes(nodes, transformExtensionNode); - -// Register all five asynchronous/frontend-compatible extensions together. -export const extensionsPlugin: MarkdownPlugin = (parser) => { - parser.addAstTransform(extensionsTransform); - smilesInlinePlugin(parser); -}; diff --git a/package/parser/src/plugin/highlight.ts b/package/parser/src/plugin/highlight.ts deleted file mode 100644 index 348d9ff..0000000 --- a/package/parser/src/plugin/highlight.ts +++ /dev/null @@ -1,41 +0,0 @@ -// @ffm/parser/src/plugin/highlight.ts -import type { ASTNode, ASTTransform, MarkdownPlugin } from '#/type'; -import { mapAstNodes } from './ast'; - -const languageAliases: Record = { - 'c++': 'cpp', - 'c#': 'csharp', - cs: 'csharp', - js: 'javascript', - ts: 'typescript', - sh: 'bash', - yml: 'yaml', - html: 'xml', - md: 'markdown', - rs: 'rust', - rb: 'ruby', - pl: 'perl', - ps1: 'powershell', - py: 'python', -}; - -// Normalize fenced-code aliases to the language names used by highlight.js. -export const normalizeHighlightLanguage = (rawLanguage: string): string => { - const language = rawLanguage.trim().split(/\s+/u)[0]?.toLowerCase() ?? ''; - return languageAliases[language] ?? language; -}; - -export const highlightTransform: ASTTransform = (nodes) => - mapAstNodes(nodes, (node) => { - if (node.type !== 'code_block') return node; - - const language = normalizeHighlightLanguage(String(node.lang ?? '')); - return language && language !== node.lang - ? { ...node, lang: language } - : node; - }); - -// Register language normalization for asynchronous highlight.js processing. -export const highlightPlugin: MarkdownPlugin = (parser) => { - parser.addAstTransform(highlightTransform); -}; diff --git a/package/parser/src/plugin/highlight/index.ts b/package/parser/src/plugin/highlight/index.ts new file mode 100644 index 0000000..8cb21e5 --- /dev/null +++ b/package/parser/src/plugin/highlight/index.ts @@ -0,0 +1,95 @@ +// @ffm/parser/src/plugin/highlight/index.ts +import { loadModule, loadSideEffectScript } from '@fuyeor/util'; +import { mapAstNode } from '#/plugin/ast'; +import { getDisplayName, getIdentifier, supportHighlight } from './util'; +import type { ASTTransform, AsyncRenderer, MarkdownPlugin } from '#/type'; +import type { Highlight, HighlightSource } from './type'; + +// Extend the Window interface to include our highlight property +declare global { + interface Window { + // highlight.js 硬编码查找叫 `window.hljs` 的对象 + hljs?: Highlight; + } +} + +// 内置语言懒加载映射表(Vite 自动打包为独立 Chunk 文件) +const builtIn: Record Promise<{ default: any }>> = { + ffm: () => import('./language/ffm'), + fon: () => import('./language/fon'), + fer: () => import('./language/fer'), +}; + +export const highlightTransform: ASTTransform = (nodes) => + mapAstNode(nodes, (node) => { + if (node.type !== 'code') return node; + + const normalized = getIdentifier(node.lang || ''); + const display = getDisplayName(normalized || 'Text'); + + return { + ...node, + lang: normalized, + // attach display name in AST + displayName: display, + }; + }); + +// Build a highlight.js renderer driven by `data-language` and a language registry. +export const createHighlight = ( + source: HighlightSource, +): AsyncRenderer => ({ + name: 'hljs', + selector: '[data-async="hljs"]', + style: source.style, + async load() { + // 加载 ESM 模块并从中获取默认导出的 highlight 对象 + const module = await loadModule<{ default: Highlight }>(source.script); + const highlight = module.default as Highlight; + + // 关键:将核心 highlight 对象暴露到全局,以便语言包脚本能够找到它 + if (!window.hljs) window.hljs = highlight; + + // 配置已在全局加载的 highlight 实例 + if (highlight?.isInitialized) { + highlight.configure({ ignoreUnescapedHTML: true }); // 忽略未转义HTML的安全警告 + highlight.isInitialized = true; // 添加标记防止重复配置 + } + + return highlight; + }, + async render(element, hljs) { + // 从
     元素上获取语言
    +    const language = element.dataset.language;
    +    if (!language) return;
    +
    +    // 找到内部的  元素进行高亮
    +    const code = element.querySelector('code');
    +    if (!code) return;
    +
    +    // 如果语言尚未注册,则动态加载
    +    if (!hljs.getLanguage(language)) {
    +      // 优先本地注册表(内置 ffm/fon/fer 或 source.register)
    +      const localLoader = builtIn[language] || source.register?.[language];
    +      if (localLoader) {
    +        const module = await localLoader();
    +        hljs.registerLanguage(language, module.default);
    +      }
    +      // 外部 CDN 语言加载
    +      else if (supportHighlight.has(language) && source.language) {
    +        await loadSideEffectScript(source.language(language));
    +      }
    +    }
    +
    +    // 再次检查语言是否已成功加载并注册
    +    if (hljs.getLanguage(language)) {
    +      hljs.highlightElement(code); // 高亮  元素
    +    }
    +  },
    +});
    +
    +// Register language normalization for asynchronous highlight.js processing.
    +export const highlightPlugin: MarkdownPlugin = (parser) => {
    +  parser.addAstTransform(highlightTransform);
    +  parser.requireCapability('hljs');
    +};
    diff --git a/package/parser/src/plugin/highlight/language/fer.ts b/package/parser/src/plugin/highlight/language/fer.ts
    new file mode 100644
    index 0000000..72e819c
    --- /dev/null
    +++ b/package/parser/src/plugin/highlight/language/fer.ts
    @@ -0,0 +1,68 @@
    +// @ffm/parser/src/plugin/highlight/language/fer.ts
    +import type { Language } from '#/plugin/highlight/type';
    +
    +/**
    + * Highlight.js grammar definition for Fer Programming Language.
    + */
    +export default function fer(hljs: any): Language {
    +  return {
    +    name: 'Fer',
    +    keywords: {
    +      keyword: 'struct enum exports',
    +      type: 'i8 i16 i32 i64 i128 u8 u16 u32 u64 u128 f32 f64 bool string char byte int float',
    +      literal: 'true false',
    +      operator:
    +        'and or not in contains matches starts ends less more least most equals',
    +    },
    +    contains: [
    +      // 注释支持 (//, /* */, ///)
    +      hljs.C_LINE_COMMENT_MODE,
    +      hljs.C_BLOCK_COMMENT_MODE,
    +      // 反引号字符串,内嵌逃逸符与 {...} 变量插值
    +      {
    +        className: 'string',
    +        begin: /`/,
    +        end: /`/,
    +        contains: [
    +          hljs.BACKSLASH_ESCAPE,
    +          {
    +            className: 'subst',
    +            begin: /\{/,
    +            end: /\}/,
    +          },
    +        ],
    +      },
    +      // 数字
    +      {
    +        className: 'number',
    +        begin: /\b[0-9]+\b/,
    +      },
    +      // 类型定义 (如 CustomType: struct)
    +      {
    +        className: 'type',
    +        // 必须以大写开头,后面可以跟着小写,并且可以重复这种“大写+小写”的结构
    +        begin: /\b[A-Z][a-z0-9\-]+([A-Z][a-z0-9\-]+)*\b/,
    +      },
    +      // 函数调用 (function-name()
    +      {
    +        className: 'title.function',
    +        begin: /\b[a-z0-9\-]+\s*(?=\()/,
    +      },
    +      // 常量 / 变量赋值 (var-name =)
    +      {
    +        className: 'property',
    +        begin: /\b[a-z][a-z0-9\-]*\s*(?=\=)/,
    +      },
    +      // 运算符与赋值符 (->, =>, =, <=, >=, <, >)
    +      {
    +        className: 'operator',
    +        begin: /(->|=>|<=|>=|=|<|>)/,
    +      },
    +      // 标点界定符
    +      {
    +        className: 'punctuation',
    +        begin: /[{}()\[\],]/,
    +      },
    +    ],
    +  };
    +}
    diff --git a/package/parser/src/plugin/highlight/language/ffm.ts b/package/parser/src/plugin/highlight/language/ffm.ts
    new file mode 100644
    index 0000000..894ad82
    --- /dev/null
    +++ b/package/parser/src/plugin/highlight/language/ffm.ts
    @@ -0,0 +1,73 @@
    +// @ffm/parser/src/plugin/highlight/language/ffm.ts
    +import type { Language } from '#/plugin/highlight/type';
    +
    +/**
    + * Highlight.js grammar definition for Fuyeor Flavored Markdown (FFM).
    + */
    +export default function ffm(): Language {
    +  return {
    +    name: 'FFM',
    +    aliases: ['ffm', 'markdown', 'md'],
    +    contains: [
    +      // 仅支持 ATX 风格标题 (# ## ###)
    +      {
    +        className: 'section',
    +        begin: /^#{1,6}\s+.*$/,
    +      },
    +      // FFM 特殊块语法:slide, chain, accordion, quote 等
    +      {
    +        className: 'meta',
    +        begin: /^(`{3,4})(slide|chain|accordion|quote|mermaid|smiles|abc)\b/,
    +        end: '\\1',
    +      },
    +      // 通用栅栏代码块 (```)
    +      // 用字符串 '\\1' 匹配组 1 (N 个反引号)
    +      {
    +        className: 'code',
    +        begin: /^(`{3,})/,
    +        end: '\\1',
    +      },
    +      // 行内代码 (`code`)
    +      {
    +        className: 'code',
    +        begin: /`/,
    +        end: /`/,
    +      },
    +      // 删除线 (--strikethrough--)
    +      {
    +        className: 'deletion',
    +        begin: /--/,
    +        end: /--/,
    +      },
    +      // 下划线 (__underline__)
    +      {
    +        className: 'underline',
    +        begin: /__/,
    +        end: /__/,
    +      },
    +      // 加粗 (**bold**)
    +      {
    +        className: 'strong',
    +        begin: /\*\*/,
    +        end: /\*\*/,
    +      },
    +      // 斜体 (*italic*)
    +      {
    +        className: 'emphasis',
    +        begin: /\*/,
    +        end: /\*/,
    +      },
    +      // 引用行 (>)
    +      {
    +        className: 'quote',
    +        begin: /^\s*>\s*.*$/,
    +      },
    +      // LaTeX 行内与块级公式 ($...$ 或 $$...$$)
    +      {
    +        className: 'formula',
    +        begin: /\${1,2}/,
    +        end: /\${1,2}/,
    +      },
    +    ],
    +  };
    +}
    diff --git a/package/parser/src/plugin/highlight/language/fon.ts b/package/parser/src/plugin/highlight/language/fon.ts
    new file mode 100644
    index 0000000..a2b08be
    --- /dev/null
    +++ b/package/parser/src/plugin/highlight/language/fon.ts
    @@ -0,0 +1,46 @@
    +// @ffm/parser/src/plugin/highlight/language/fon.ts
    +import type { Language } from '#/plugin/highlight/type';
    +
    +/**
    + * Highlight.js grammar definition for Fer Object Notation (FON).
    + */
    +export default function fon(hljs: any): Language {
    +  return {
    +    name: 'FON',
    +    keywords: {
    +      literal: 'true false',
    +    },
    +    contains: [
    +      // 注释支持 (//, /* */, ///)
    +      hljs.C_LINE_COMMENT_MODE,
    +      hljs.C_BLOCK_COMMENT_MODE,
    +      // 反引号字符串 (`string`)
    +      {
    +        className: 'string',
    +        begin: /`/,
    +        end: /`/,
    +        contains: [hljs.BACKSLASH_ESCAPE],
    +      },
    +      // 数字
    +      {
    +        className: 'number',
    +        begin: /\b[0-9]+\b/,
    +      },
    +      // 键与属性声明 (key = 或 key:)
    +      {
    +        className: 'attr',
    +        begin: /\b[a-z0-9\-]+\s*(?=\=|:)/,
    +      },
    +      // 标点分割与界定符
    +      {
    +        className: 'punctuation',
    +        begin: /[{}()\[\],]/,
    +      },
    +      // 赋值与冒号算子
    +      {
    +        className: 'operator',
    +        begin: /(=|:)/,
    +      },
    +    ],
    +  };
    +}
    diff --git a/package/parser/src/plugin/highlight/type.ts b/package/parser/src/plugin/highlight/type.ts
    new file mode 100644
    index 0000000..682bd58
    --- /dev/null
    +++ b/package/parser/src/plugin/highlight/type.ts
    @@ -0,0 +1,36 @@
    +// @ffm/parser/src/plugin/highlight/type.ts
    +
    +export type LanguageDefinition = (highlight: any) => Language;
    +
    +export interface Highlight {
    +  getLanguage(languageName: string): Language | undefined;
    +  highlightElement(element: Element): void;
    +  // registerLanguage 函数声明
    +  registerLanguage(
    +    languageName: string,
    +    languageDefinition: LanguageDefinition,
    +  ): void;
    +  configure(options: { ignoreUnescapedHTML: boolean }): void;
    +  isInitialized?: boolean;
    +}
    +
    +export interface HighlightSource {
    +  /** highlight.js core CDN URL */
    +  script: string;
    +  /** highlight CSS */
    +  style?: readonly string[];
    +  /**
    +   * 外部官方语言的 CDN URL 解析函数
    +   * e.g. (lang) => getCdnLibraryUrl(`highlight.js/11.11.1/languages/${lang}.min.js`)
    +   */
    +  language?: (lang: string) => string;
    +  /** user registered language */
    +  register?: Record Promise<{ default: LanguageDefinition }>>;
    +}
    +
    +export interface Language {
    +  name: string;
    +  aliases?: string[];
    +  contains?: any[];
    +  keywords?: Record | string;
    +}
    diff --git a/package/parser/src/plugin/highlight/util.ts b/package/parser/src/plugin/highlight/util.ts
    new file mode 100644
    index 0000000..dc5bcb7
    --- /dev/null
    +++ b/package/parser/src/plugin/highlight/util.ts
    @@ -0,0 +1,108 @@
    +// @ffm/parser/src/plugin/highlight/util.ts
    +
    +/**
    + * 语言别名映射表,用于统一请求 CDN 语言标识符。
    + */
    +export const highlightNameMap: Record = {
    +  'c++': 'cpp',
    +  'c#': 'csharp',
    +  cs: 'csharp',
    +  js: 'javascript',
    +  ts: 'typescript',
    +  sh: 'bash',
    +  yml: 'yaml',
    +  html: 'xml', // 官方没有 html
    +  md: 'markdown',
    +  rs: 'rust',
    +  rb: 'ruby',
    +  pl: 'perl',
    +  ps1: 'powershell',
    +  py: 'python',
    +} as const;
    +
    +/**
    + * 统一规整语言标识符:转小写,并映射别名 (如 c++ -> cpp, TS -> typescript)
    + */
    +export function getIdentifier(lang: string): string {
    +  const lower = lang.trim().toLowerCase();
    +  return highlightNameMap[lower] || lower;
    +}
    +
    +// 一个小型的、针对特殊写法的映射表
    +const displayNameMap: Record = {
    +  javascript: 'JavaScript',
    +  typescript: 'TypeScript',
    +
    +  xml: 'XML',
    +  html: 'HTML',
    +  css: 'CSS',
    +  scss: 'SCSS',
    +  json: 'JSON',
    +
    +  yaml: 'YAML',
    +  svg: 'SVG',
    +
    +  cpp: 'C++',
    +  csharp: 'C#',
    +  objectivec: 'Objective-C',
    +
    +  php: 'PHP',
    +  vbnet: 'VB.NET',
    +
    +  sql: 'SQL',
    +  pgsql: 'PostgreSQL',
    +
    +  x86asm: 'x86 Assembly',
    +  armasm: 'ARM Assembly',
    +  mipsasm: 'MIPS Assembly',
    +
    +  ffm: 'Fuyeor Flavored Markdown',
    +  fon: 'FON',
    +} as const;
    +
    +// 语言显示名称工具
    +export function getDisplayName(lang: string): string {
    +  if (!lang) return '';
    +  const lowerLang = lang.toLowerCase();
    +  // 优先使用特殊写法,否则自动将首字母大写
    +  return (
    +    displayNameMap[lowerLang] ||
    +    lowerLang.charAt(0).toUpperCase() + lowerLang.slice(1)
    +  );
    +}
    +
    +/**
    + * highlight.js 官方支持的语言权威列表。
    + * 避免自定义语言出现加载错误的不专业控制台报错
    + * 使用 Set 提供 O(1) 的高效查找。
    + */
    +// prettier-ignore
    +export const supportHighlight = new Set([
    +  '1c', 'abnf', 'accesslog', 'actionscript', 'ada', 'angelscript', 'apache',
    +  'applescript', 'arcade', 'arduino', 'armasm', 'asciidoc', 'aspectj',
    +  'autohotkey', 'autoit', 'avrasm', 'awk', 'axapta', 'bash', 'basic', 'bnf',
    +  'brainfuck', 'c', 'cal', 'capnproto', 'ceylon', 'clean', 'clojure-repl',
    +  'clojure', 'cmake', 'coffeescript', 'coq', 'cos', 'cpp', 'crmsh', 'crystal',
    +  'csharp', 'csp', 'css', 'd', 'dart', 'delphi', 'diff', 'django', 'dns',
    +  'dockerfile', 'dos', 'dsconfig', 'dts', 'dust', 'ebnf', 'elixir', 'elm',
    +  'erb', 'erlang-repl', 'erlang', 'excel', 'fix', 'flix', 'fortran', 'fsharp',
    +  'gams', 'gauss', 'gcode', 'gherkin', 'glsl', 'gml', 'go', 'golo', 'gradle',
    +  'graphql', 'groovy', 'haml', 'handlebars', 'haskell', 'haxe', 'hsp',
    +  'http', 'hy', 'inform7', 'ini', 'irpf90', 'isbl', 'java', 'javascript',
    +  'jboss-cli', 'json', 'julia-repl', 'julia', 'kotlin', 'lasso', 'latex',
    +  'ldif', 'leaf', 'less', 'lisp', 'livecodeserver', 'livescript', 'llvm',
    +  'lsl', 'lua', 'makefile', 'markdown', 'mathematica', 'matlab', 'maxima',
    +  'mel', 'mercury', 'mipsasm', 'mizar', 'mojolicious', 'monkey', 'moonscript',
    +  'n1ql', 'nestedtext', 'nginx', 'nim', 'nix', 'node-repl', 'nsis',
    +  'objectivec', 'ocaml', 'openscad', 'oxygene', 'parser3', 'perl', 'pf',
    +  'pgsql', 'php-template', 'php', 'pony', 'powershell',
    +  'processing', 'profile', 'prolog', 'properties', 'protobuf', 'puppet',
    +  'purebasic', 'python-repl', 'python', 'q', 'qml', 'r', 'reasonml', 'rib',
    +  'roboconf', 'routeros', 'rsl', 'ruby', 'ruleslanguage', 'rust', 'sas',
    +  'scala', 'scheme', 'scilab', 'scss', 'shell', 'smali', 'smalltalk', 'sml',
    +  'sqf', 'sql', 'stan', 'stata', 'step21', 'stylus', 'subunit', 'swift',
    +  'taggerscript', 'tap', 'tcl', 'thrift', 'tp', 'twig', 'typescript',
    +  'vala', 'vbnet', 'vbscript-html', 'vbscript', 'verilog', 'vhdl', 'vim',
    +  'wasm', 'wren', 'x86asm', 'xl', 'xml', 'xquery', 'yaml', 'zephir',
    +  'ffm', 'fon', 'fer'
    +]);
    diff --git a/package/parser/src/plugin/hydrate.ts b/package/parser/src/plugin/hydrate.ts
    new file mode 100644
    index 0000000..50bd6a4
    --- /dev/null
    +++ b/package/parser/src/plugin/hydrate.ts
    @@ -0,0 +1,60 @@
    +// @ffm/parser/src/plugin/hydrate.ts
    +import { loadStyleSheet } from '@fuyeor/util';
    +import type { AsyncCapability, AsyncRenderer, HydrateOption } from '#/type';
    +
    +// Walk a container and hydrate every declared async capability in parallel.
    +export async function hydrate(
    +  root: ParentNode,
    +  renderers: readonly AsyncRenderer[],
    +  option?: HydrateOption,
    +): Promise {
    +  const acquisition = new Map>();
    +  const tasks: Promise[] = [];
    +
    +  for (const renderer of renderers) {
    +    if (option?.capability && !option.capability.has(renderer.name)) continue;
    +
    +    const elements = root.querySelectorAll(
    +      `${renderer.selector}:not([data-ffm-rendered])`,
    +    );
    +    if (elements.length === 0) continue;
    +
    +    renderer.style?.forEach(loadStyleSheet);
    +
    +    tasks.push(
    +      run(renderer, elements, acquisition, option?.onError).catch((error) => {
    +        option?.onError?.(renderer.name, error);
    +      }),
    +    );
    +  }
    +
    +  await Promise.allSettled(tasks);
    +}
    +
    +async function run(
    +  renderer: AsyncRenderer,
    +  elements: NodeListOf,
    +  acquisition: Map>,
    +  onError: HydrateOption['onError'],
    +): Promise {
    +  let pending = acquisition.get(renderer.name);
    +  if (!pending) {
    +    pending = (async () => {
    +      if (renderer.style) await Promise.all(renderer.style.map(loadStyleSheet));
    +      return renderer.load();
    +    })();
    +    acquisition.set(renderer.name, pending);
    +  }
    +  const lib = await pending;
    +
    +  const results = await Promise.allSettled(
    +    Array.from(elements, (element) => {
    +      element.dataset.ffmRendered = 'true';
    +      return renderer.render(element, lib);
    +    }),
    +  );
    +
    +  for (const result of results) {
    +    if (result.status === 'rejected') onError?.(renderer.name, result.reason);
    +  }
    +}
    diff --git a/package/parser/src/plugin/index.ts b/package/parser/src/plugin/index.ts
    new file mode 100644
    index 0000000..7aa769b
    --- /dev/null
    +++ b/package/parser/src/plugin/index.ts
    @@ -0,0 +1,20 @@
    +// @ffm/parser/src/plugin/index.ts
    +export { hydrate } from './hydrate';
    +
    +export { createAbc } from './abc';
    +export { highlightPlugin, createHighlight } from './highlight';
    +export { default as fer } from './highlight/language/fer';
    +export { default as ffm } from './highlight/language/ffm';
    +export { default as fon } from './highlight/language/fon';
    +export { getIdentifier, getDisplayName } from './highlight/util';
    +export {
    +  latexInlineRule,
    +  latexBlockRule,
    +  latexPlugin,
    +  createLatex,
    +} from './latex';
    +export { createMermaid } from './mermaid';
    +export { createSmiles } from './smiles';
    +export { twemojiPlugin, transformTwemojiNode, getTwemojiUrl } from './twemoji';
    +
    +export type { AsyncCapability, AsyncRenderer, HydrateOption } from '#/type';
    diff --git a/package/parser/src/plugin/latex.ts b/package/parser/src/plugin/latex/index.ts
    similarity index 77%
    rename from package/parser/src/plugin/latex.ts
    rename to package/parser/src/plugin/latex/index.ts
    index 4936f0a..6953f15 100644
    --- a/package/parser/src/plugin/latex.ts
    +++ b/package/parser/src/plugin/latex/index.ts
    @@ -1,6 +1,13 @@
    -// @ffm/parser/src/plugin/latex.ts
    +// @ffm/parser/src/plugin/latex/index.ts
    +import { loadScript } from '@fuyeor/util';
     import { BlockState, InlineState } from '#/core/state';
    -import type { BlockRule, InlineRule, MarkdownPlugin } from '#/type';
    +import type {
    +  BlockRule,
    +  InlineRule,
    +  AsyncRenderer,
    +  MarkdownPlugin,
    +} from '#/type';
    +import type { Katex, KatexSource } from './type';
     
     const inlineMathMarker = '$';
     const blockMathMarker = '$$';
    @@ -55,7 +62,7 @@ export const latexInlineRule: InlineRule = {
     
     // Parse a $$...$$ formula as one block, including formulas spanning lines.
     export const latexBlockRule: BlockRule = {
    -  name: 'math_block',
    +  name: 'math',
       marker: [inlineMathMarker],
       parse(state: BlockState) {
         const firstLine = state.currentLine;
    @@ -85,7 +92,7 @@ export const latexBlockRule: BlockRule = {
     
         return {
           node: {
    -        type: 'math_block',
    +        type: 'math',
             value: contentLines.join('\n').trim(),
           },
           consumedLines,
    @@ -93,7 +100,24 @@ export const latexBlockRule: BlockRule = {
       },
     };
     
    +// Build a KaTeX renderer; CDN URLs are supplied by the host.
    +export const createLatex = (source: KatexSource): AsyncRenderer => ({
    +  name: 'latex',
    +  selector: '[data-async="latex"]',
    +  style: source.style,
    +  // katex will finds `window.katex`
    +  load: () => loadScript(source.script, 'katex'),
    +  render(element, latex) {
    +    latex.render(element.textContent ?? '', element, {
    +      throwOnError: false,
    +      output: 'html',
    +      displayMode: element.classList.contains('math-block'),
    +    });
    +  },
    +});
    +
     // Register LaTeX block and inline rules on a markdown-parser instance.
     export const latexPlugin: MarkdownPlugin = (parser) => {
       parser.addBlockRule(latexBlockRule).addInlineRule(latexInlineRule);
    +  parser.requireCapability('latex');
     };
    diff --git a/package/parser/src/plugin/latex/type.ts b/package/parser/src/plugin/latex/type.ts
    new file mode 100644
    index 0000000..0abeea4
    --- /dev/null
    +++ b/package/parser/src/plugin/latex/type.ts
    @@ -0,0 +1,21 @@
    +// @ffm/parser/src/plugin/latex/type.ts
    +
    +export interface Katex {
    +  render(
    +    text: string,
    +    element: HTMLElement,
    +    options?: {
    +      displayMode?: boolean;
    +      throwOnError?: boolean;
    +      errorColor?: string;
    +      macros?: Record;
    +      colorIsTextColor?: boolean;
    +      output?: 'html' | 'mathml' | 'htmlAndMathml';
    +    },
    +  ): void;
    +}
    +
    +export interface KatexSource {
    +  script: string;
    +  style?: readonly string[];
    +}
    diff --git a/package/parser/src/plugin/mermaid/index.ts b/package/parser/src/plugin/mermaid/index.ts
    new file mode 100644
    index 0000000..7a8ca79
    --- /dev/null
    +++ b/package/parser/src/plugin/mermaid/index.ts
    @@ -0,0 +1,61 @@
    +// @ffm/parser/src/plugin/mermaid/index.ts
    +import { loadScript, sanitizeHtml } from '@fuyeor/util';
    +import { createCodeBlockTransform } from '#/plugin/ast';
    +import type { AsyncRenderer, MarkdownPlugin } from '#/type';
    +import type { Mermaid, MermaidSource } from './type';
    +
    +let sequence = 0;
    +
    +export const mermaidTransform = createCodeBlockTransform('mermaid');
    +
    +// Build a Mermaid renderer with strict security enforced at initialization.
    +export const createMermaid = (
    +  source: MermaidSource,
    +): AsyncRenderer => ({
    +  name: 'mermaid',
    +  selector: '[data-async="mermaid"]',
    +  style: source.style,
    +  async load() {
    +    const mermaid = await loadScript(source.script, 'mermaid');
    +    mermaid.initialize({
    +      startOnLoad: false,
    +      securityLevel: 'strict', // 启用严格安全模式,禁止脚本和事件
    +      suppressErrorRendering: true, // 禁用渲染时的语法错误提示
    +    });
    +    return mermaid;
    +  },
    +  async render(element, mermaid) {
    +    const code = element.textContent
    +      // 替换换行符(是因为 `
    ` 会导致 photoswipe 无法渲染图片) + .replace(/<\s*br\s*\/?>/gi, '\n'); + + // 输入净化:在代码交给 Mermaid 之前,剥离所有 HTML 标签,只留下纯文本 + // 防止 img 标签 XSS 问题,需移除全部标签 + const cleanCode = sanitizeHtml(code, 'text'); + + // 如果清洗后为空,则直接终止,避免 Mermaid 崩溃 + if (!cleanCode.trim()) { + element.replaceChildren(); // 清空占位符,行为与渲染失败保持一致 + return; // 提前退出 + } + + try { + // 输出净化:使用绝对干净的代码进行解析和渲染 + await mermaid.parse(cleanCode); + const { svg } = await mermaid.render( + `ffm-mermaid-${sequence++}`, + cleanCode, + ); + + // 使用 svg 模式清洗输出 + element.innerHTML = sanitizeHtml(svg, 'svg'); + } catch { + element.replaceChildren(); + } + }, +}); + +export const mermaidPlugin: MarkdownPlugin = (parser) => { + parser.addAstTransform(mermaidTransform); + parser.requireCapability('mermaid'); +}; diff --git a/package/parser/src/plugin/mermaid/type.ts b/package/parser/src/plugin/mermaid/type.ts new file mode 100644 index 0000000..28f67bb --- /dev/null +++ b/package/parser/src/plugin/mermaid/type.ts @@ -0,0 +1,22 @@ +// @ffm/parser/src/plugin/mermaid/type.ts + +export interface Mermaid { + parse(code: string): Promise; + render( + id: string, + code: string, + ): Promise<{ svg: string; bindFunctions?: (element: Element) => void }>; + initialize(config: { + startOnLoad?: boolean; + securityLevel?: string; + suppressErrorRendering?: boolean; + }): void; + isInitialized?: boolean; +} + +export interface MermaidSource { + script: string; + style?: readonly string[]; + /** SVG 渲染成功后的回调钩子 (可在此注入灯箱预览、缩放逻辑) */ + afterRender?: (element: HTMLElement, svg: string) => void; +} diff --git a/package/parser/src/plugin/smiles/index.ts b/package/parser/src/plugin/smiles/index.ts new file mode 100644 index 0000000..0267b49 --- /dev/null +++ b/package/parser/src/plugin/smiles/index.ts @@ -0,0 +1,81 @@ +// @ffm/parser/src/plugin/smiles/index.ts +import { createCodeBlockTransform } from '#/plugin/ast'; +import type { + InlineRule, + InlineState, + AsyncRenderer, + MarkdownPlugin, +} from '#/type'; + +export interface SmilesSource { + endpoint: string; + limit?: number; +} + +const defaultLimit = 100; +const inlineRegex = /^#\[smiles\s*=\s*`([^`]+)`\]/u; + +// Parse the FFM #[smiles = `...`] inline placeholder syntax. +export const smilesInlineRule: InlineRule = { + name: 'smiles_inline', + marker: ['#'], + parse(state: InlineState) { + if (state.currentChar !== '#') return null; + + const match = state.content.slice(state.pos).match(inlineRegex); + if (!match) return null; + + return { + node: { type: 'smiles_inline', value: match[1].trim() }, + consumedChars: match[0].length, + }; + }, +}; + +// 块级规则 +export const smilesBlockTransform = createCodeBlockTransform('smiles'); + +// Build a SMILES renderer with per-code deduplication and bounded cache. +export const createSmiles = (source: SmilesSource): AsyncRenderer => { + const limit = source.limit ?? defaultLimit; + const cache = new Map>(); + + const fetchSmiles = (smiles: string): Promise => { + const existing = cache.get(smiles); + if (existing) return existing; + + const promise = window + .fetch(`${source.endpoint}?smiles=${encodeURIComponent(smiles)}`) + .then((response) => { + if (!response.ok) + throw new Error(`SMILES request failed: ${response.status}`); + return response.text(); + }); + + promise.catch(() => cache.delete(smiles)); + if (cache.size >= limit) { + const oldest = cache.keys().next().value; + if (oldest !== undefined) cache.delete(oldest); + } + cache.set(smiles, promise); + return promise; + }; + + return { + name: 'smiles', + selector: '[data-async="smiles"]', + load: () => Promise.resolve(), + async render(element) { + const smiles = element.dataset.smiles; + if (!smiles) return; + element.innerHTML = await fetchSmiles(smiles); + }, + }; +}; + +// Register both FFM inline and fenced Smiles syntax. +export const smilesPlugin: MarkdownPlugin = (parser) => { + parser.addAstTransform(smilesBlockTransform); + parser.addInlineRule(smilesInlineRule); + parser.requireCapability('smiles'); +}; diff --git a/package/parser/src/plugin/twemoji.ts b/package/parser/src/plugin/twemoji/index.ts similarity index 89% rename from package/parser/src/plugin/twemoji.ts rename to package/parser/src/plugin/twemoji/index.ts index fb01ac1..1ba6a4b 100644 --- a/package/parser/src/plugin/twemoji.ts +++ b/package/parser/src/plugin/twemoji/index.ts @@ -1,6 +1,6 @@ -// @ffm/parser/src/plugin/twemoji.ts +// @ffm/parser/src/plugin/twemoji/index.ts import type { ASTNode, ASTTransform, MarkdownPlugin } from '#/type'; -import { mapAstNodes } from './ast'; +import { mapAstNode } from '#/plugin/ast'; const r = String.raw; const baseEmojiPattern = r`\p{Emoji}(?:\p{EMod}|[\u{E0020}-\u{E007E}]+\u{E007F}|\uFE0F?\u20E3?)`; @@ -54,7 +54,7 @@ export const transformTwemojiNode = (node: ASTNode): ASTNode[] => { }; export const twemojiTransform: ASTTransform = (nodes) => - mapAstNodes(nodes, (node) => + mapAstNode(nodes, (node) => node.type === 'text' ? transformTwemojiNode(node) : node, ); @@ -62,6 +62,3 @@ export const twemojiTransform: ASTTransform = (nodes) => export const twemojiPlugin: MarkdownPlugin = (parser) => { parser.addAstTransform(twemojiTransform); }; - -// Keep the name used by the existing Interactify markdown-it integration. -export const nativeEmojiPlugin = twemojiPlugin; diff --git a/package/parser/src/rule/block.ts b/package/parser/src/rule/block.ts index da7261c..3b23c29 100644 --- a/package/parser/src/rule/block.ts +++ b/package/parser/src/rule/block.ts @@ -41,14 +41,14 @@ export const headingRule: BlockRule = { * parse ``` fenced code block */ export const codeBlockRule: BlockRule = { - name: 'code_block', + name: 'code', marker: ['`', '~'], parse(state: BlockState) { const block = extractFencedBlock(state); if (!block) return null; return { - node: { type: 'code_block', lang: block.lang, value: block.content }, + node: { type: 'code', lang: block.lang, value: block.content }, consumedLines: block.consumedLines, }; }, diff --git a/package/parser/src/rule/ffm.ts b/package/parser/src/rule/ffm.ts index 1a06ec5..8c7f937 100644 --- a/package/parser/src/rule/ffm.ts +++ b/package/parser/src/rule/ffm.ts @@ -16,7 +16,7 @@ const nodeTitleRegex = /^\s*\*\*(?:\[([ xX])\]\s*)?(.+?)\*\*\s*$/; * intercept special fuyeor flavored markdown blocks (accordion, slide, chain, quote) */ export const ffmBlockRule: BlockRule = { - name: 'ffm_blocks', + name: 'ffm', // same as code block to leverage fenced block parsing marker: ['`', '~'], parse(state: BlockState, ctx) { @@ -128,7 +128,7 @@ export const ffmBlockRule: BlockRule = { // fallback return { - node: { type: 'code_block', lang: type, value: rawContent }, + node: { type: 'code', lang: type, value: rawContent }, consumedLines, }; }, diff --git a/package/parser/src/rule/inline.ts b/package/parser/src/rule/inline.ts index 67385d1..5fc6fcf 100644 --- a/package/parser/src/rule/inline.ts +++ b/package/parser/src/rule/inline.ts @@ -1,25 +1,8 @@ // @ffm/parser/src/rule/inline.ts -import type { InlineRule } from '#/type'; import { InlineState } from '#/core/state'; import { isSafeColorValue } from '#/core/color'; import { isSafeLinkUrl } from '#/core/url'; - -/** - * Support backslash at line end as
    - */ -export const hardBreakRule: InlineRule = { - name: 'hardbreak', - marker: ['\\', ' '], - parse(state: InlineState) { - if (state.currentChar === '\\' && state.content[state.pos + 1] === '\n') { - return { - node: { type: 'hardbreak' }, - consumedChars: 2, - }; - } - return null; - }, -}; +import type { ASTNode, InlineRule } from '#/type'; /** * parse **bold** syntax @@ -30,17 +13,20 @@ export const boldRule: InlineRule = { parse(state: InlineState, ctx) { if (!state.content.startsWith('**', state.pos)) return null; - // find directly for the next **; - // if not found, treat it as plain text. - const endIdx = state.findNextToken('**', state.pos + 2); + const innerStart = state.pos + 2; + // 起始为 *** 时,内部以 * 开头(斜体标记) + const nested = state.content[innerStart] === '*'; + + let endIdx = state.findNextToken('**', innerStart); if (endIdx === -1) return null; - const innerContent = state.content.slice(state.pos + 2, endIdx); + // 结束也是 *** 时,跳过结束序列的首个 *,让内层 * 闭合斜体 + if (nested && state.content[endIdx + 2] === '*') endIdx += 1; + return { node: { type: 'bold', - // supports nested parsing - content: ctx.parseInline(innerContent), + content: ctx.parseInline(state.content.slice(innerStart, endIdx)), }, // +2 is because the followed `**` was consumed consumedChars: endIdx - state.pos + 2, @@ -49,31 +35,25 @@ export const boldRule: InlineRule = { }; /** - * parse *italic* or _italic_ syntax + * parse *italic* syntax */ export const italicRule: InlineRule = { name: 'italic', marker: ['*'], parse(state: InlineState, ctx) { - const char = state.currentChar; - // only triggers when it starts with * and - // is not immediately followed by the same symbol - // (to prevent it from overriding the bold/underline). - if (char === '*' && state.content[state.pos + 1] !== char) { - // find the next matching closing symbol - const endIdx = state.findNextToken(char, state.pos + 1); + // 下一个字符也是 * 时让位给 boldRule + if (state.content[state.pos + 1] === '*') return null; - if (endIdx === -1 || endIdx === state.pos + 1) return null; + const endIdx = state.findNextToken('*', state.pos + 1); + if (endIdx === -1) return null; - return { - node: { - type: 'italic', - content: ctx.parseInline(state.content.slice(state.pos + 1, endIdx)), - }, - consumedChars: endIdx - state.pos + 1, - }; - } - return null; + return { + node: { + type: 'italic', + content: ctx.parseInline(state.content.slice(state.pos + 1, endIdx)), + }, + consumedChars: endIdx - state.pos + 1, + }; }, }; @@ -81,7 +61,7 @@ export const italicRule: InlineRule = { * parse `inlineCode` syntax */ export const inlineCodeRule: InlineRule = { - name: 'inline_code', + name: 'code_inline', marker: ['`'], parse(state: InlineState) { if (state.currentChar !== '`') return null; @@ -126,12 +106,12 @@ export const inlineCodeRule: InlineRule = { rawContent = rawContent.slice(1, -1); } - // if it is a color, directly change it to a `color_code` node + // if it is a color, directly change it to a `code_color` node const isColor = isSafeColorValue(rawContent); return { node: { - type: isColor ? 'color_code' : 'inline_code', + type: isColor ? 'code_color' : 'code_inline', value: rawContent, }, consumedChars: endIdx + markerLength - state.pos, @@ -218,3 +198,43 @@ export const strikeRule: InlineRule = { }; }, }; + +/** + * parse ![alt](url "caption") syntax; opt-in via addInlineRule + */ +export const imageRule: InlineRule = { + name: 'image', + marker: ['!'], + parse(state: InlineState) { + if (state.currentChar !== '!') return null; + if (state.content[state.pos + 1] !== '[') return null; + + const altEnd = state.findNextToken('](', state.pos + 2); + if (altEnd === -1) return null; + + const urlEnd = state.findNextToken(')', altEnd + 2); + if (urlEnd === -1) return null; + + const alt = state.content.slice(state.pos + 2, altEnd).trim(); + const raw = state.content.slice(altEnd + 2, urlEnd).trim(); + + // 拆出可选的 caption 部分不含空白,title 由成对引号包裹 + const match = raw.match(/^(\S+)(?:\s+(?:"([^"]*)"|'([^']*)'))?$/); + if (!match) return null; + + const rawUrl = match[1]; + const normalizedUrl = rawUrl.startsWith('www.') + ? `http://${rawUrl}` + : rawUrl; + if (!isSafeLinkUrl(normalizedUrl)) return null; + + const node: ASTNode = { type: 'image', url: normalizedUrl, alt }; + const caption = match[2] ?? match[3]; + if (caption !== undefined) node.caption = caption; + + return { + node, + consumedChars: urlEnd - state.pos + 1, + }; + }, +}; diff --git a/package/parser/src/test/index.spec.ts b/package/parser/src/test/index.spec.ts index 5fe6b60..048aa74 100644 --- a/package/parser/src/test/index.spec.ts +++ b/package/parser/src/test/index.spec.ts @@ -1,23 +1,19 @@ // @ffm/parser/test/index.spec.ts -// pnpm test -import { readFileSync, writeFileSync } from 'node:fs'; +// pnpm -F @ffm/parser test +import { writeFileSync } from 'node:fs'; import { resolve } from 'node:path'; import { describe, it, expect, afterAll } from 'vitest'; -import { createFuyeorMarkdownParser } from '#/default'; +import { createMarkdownParser } from '#/default'; import { render } from '#/core/render'; -const parse = createFuyeorMarkdownParser(); +// commonMark: 0.13.2 edition +import commonMark from './spec/commonMark.json' with { type: 'json' }; +// githubMark: 0.29 edition +import githubMark from './spec/githubMark.json' with { type: 'json' }; + +const parse = createMarkdownParser(); const failures: any[] = []; -// load test JSON -const commonMark = JSON.parse( - // commonMark: 0.13.2 edition - readFileSync(resolve(__dirname, './spec/commonMark.json'), 'utf-8'), -); -const githubMark = JSON.parse( - // githubMark: 0.29 edition - readFileSync(resolve(__dirname, './spec/githubMark.json'), 'utf-8'), -); /** * skip unimplemented test cases */ @@ -69,7 +65,8 @@ function assertMarkdown( ) { const ast = parse(markdown); const resultHtml = render(ast).trim(); - const targetHtml = expectedHtml.trim(); + // nomalize legacy CFM `
    \n`、`
    ` or `
    ` to `
    ` + const targetHtml = expectedHtml.replaceAll(/\n?/g, '
    ').trim(); if (resultHtml !== targetHtml) { failures.push({ diff --git a/package/parser/src/type.ts b/package/parser/src/type.ts index 34e8499..9fa86a3 100644 --- a/package/parser/src/type.ts +++ b/package/parser/src/type.ts @@ -3,31 +3,37 @@ import type { LinkMatch } from '@ffm/linkify'; import type { MarkdownParser } from './core/parser'; import type { BlockState, InlineState } from './core/state'; +export type { BlockState, InlineState } from './core/state'; + // built-in type; plugins can extend the string union type export type NodeType = | 'root' | 'paragraph' | 'text' | 'heading' - | 'code_block' + | 'bold' + | 'italic' + | 'strike' + | 'underline' + | 'link' + | 'image' + | 'break' + | 'hr' | 'blockquote' + | 'code' + | 'code_inline' | 'list' | 'list_item' | 'table' | 'table_row' | 'table_cell' - | 'math_inline' - | 'math_block' | 'emoji' + | 'math' + | 'math_inline' | 'mermaid' - | 'abc' + | 'smiles' | 'smiles_inline' - | 'smiles_block' - | 'bold' - | 'italic' - | 'link' - | 'hardbreak' - | 'hr' + | 'abc' | string; export interface ASTNode { @@ -42,6 +48,9 @@ export interface ASTNode { header?: ASTNode[]; name?: string; title?: ASTNode[]; + // image description, like + // it’s actually caption, not title + caption?: string; isCompleted?: boolean; hasCheckbox?: boolean; // allow plugins to attach arbitrary attributes @@ -89,3 +98,33 @@ export interface MarkdownParserOption { export type ASTTransform = (nodes: ASTNode[]) => ASTNode[]; export type MarkdownPlugin = (parser: MarkdownParser) => void; + +// Render extension +export interface RenderContext { + render(nodes?: ASTNode[]): string; + escapeHtml(value: string): string; +} + +export type NodeRenderer = (node: ASTNode, ctx: RenderContext) => string; + +export interface RenderOption { + nodeRenderer?: Record; +} + +// Async capability contract +/** Stable identifier shared between plugin declarations and async renderers. */ +export type AsyncCapability = string; + +export interface AsyncRenderer { + readonly name: AsyncCapability; + readonly selector: string; + readonly style?: readonly string[]; + load(): Promise; + render(element: HTMLElement, lib: Lib): void | Promise; +} + +export interface HydrateOption { + /** Skip capabilities that the host has not declared. */ + capability?: ReadonlySet; + onError?: (name: AsyncCapability, error: unknown) => void; +} diff --git a/package/parser/tsconfig.json b/package/parser/tsconfig.json index 0840522..2fb0992 100644 --- a/package/parser/tsconfig.json +++ b/package/parser/tsconfig.json @@ -7,6 +7,7 @@ "target": "ESNext", "module": "ESNext", "moduleResolution": "Bundler", + "types": ["node"], "lib": ["ESNext", "DOM"], "strict": true, "isolatedModules": true, @@ -14,6 +15,5 @@ "skipLibCheck": true, "noEmit": true }, - "include": ["src/**/*.ts"], - "exclude": ["src/**/*.spec.ts", "src/test/**/*.ts"] + "include": ["src/**/*.ts"] } diff --git a/package/renderer/lit/package.json b/package/renderer/lit/package.json index 4151d9e..74757d9 100644 --- a/package/renderer/lit/package.json +++ b/package/renderer/lit/package.json @@ -1,5 +1,6 @@ { "name": "@ffm/lit-renderer", + "version": "0.1.0", "license": "MIT", "author": "Fuyeor ", "type": "module", diff --git a/package/renderer/lit/src/render.ts b/package/renderer/lit/src/render.ts index 5bea102..034142b 100644 --- a/package/renderer/lit/src/render.ts +++ b/package/renderer/lit/src/render.ts @@ -54,10 +54,10 @@ export function render(node?: ASTNode[]): (TemplateResult | string | null)[] { : html`${render(node.content)}`; } - case 'inline_code': + case 'code_inline': return html`${node.value}`; - case 'color_code': { + case 'code_color': { const color = String(node.value ?? ''); if (!isSafeColorValue(color)) return html`${color}`; return html` @@ -80,13 +80,13 @@ export function render(node?: ASTNode[]): (TemplateResult | string | null)[] { `; } - case 'code_block': + case 'code': return html`
    ${node.lang ? html`
    ${node.lang}
    ` : ''} -
    ${node.value}
    +
    ${node.value}
    `; @@ -112,7 +112,7 @@ export function render(node?: ASTNode[]): (TemplateResult | string | null)[] { case 'hr': return html`
    `; - case 'hardbreak': + case 'break': return html`
    `; case 'table': @@ -148,14 +148,14 @@ export function render(node?: ASTNode[]): (TemplateResult | string | null)[] { return html`
    ${render(node.title)} -
    ${render(node.content)}
    +
    ${render(node.content)}
    `; // FFM Slide case 'slide': return html` -
    +
    ${render(node.content)}
    `; @@ -165,7 +165,7 @@ export function render(node?: ASTNode[]): (TemplateResult | string | null)[] { // FFM Chain case 'chain': - return html`
    ${render(node.content)}
    `; + return html`
    ${render(node.content)}
    `; case 'chain_item': { const statusClass = node.hasCheckbox @@ -177,11 +177,13 @@ export function render(node?: ASTNode[]): (TemplateResult | string | null)[] { return html`
    -
    - ${node.title && node.title.length > 0 - ? html`
    ${render(node.title)}
    ` - : ''} -
    ${render(node.content)}
    +
    + ${ + node.title && node.title.length > 0 + ? html`
    ${render(node.title)}
    ` + : '' + } +
    ${render(node.content)}
    `; diff --git a/package/renderer/vue/package.json b/package/renderer/vue/package.json index 655abc1..2e125ee 100644 --- a/package/renderer/vue/package.json +++ b/package/renderer/vue/package.json @@ -1,5 +1,6 @@ { "name": "@ffm/vue-renderer", + "version": "0.1.0", "license": "MIT", "author": "Fuyeor ", "type": "module", diff --git a/package/renderer/vue/src/index.ts b/package/renderer/vue/src/index.ts index 977c027..9af32f2 100644 --- a/package/renderer/vue/src/index.ts +++ b/package/renderer/vue/src/index.ts @@ -1,2 +1,249 @@ // @ffm/vue-renderer/src/index.ts -export { renderToVue } from './render'; +import { Fragment, h, type VNode } from 'vue'; +import type { ASTNode } from '@ffm/parser'; + +// 渲染子节点;缺省时返回空数组 +const content = (node: ASTNode): (VNode | string)[] => + renderToVue(node.content ?? []); + +// 读取纯文本值;缺省时返回空串 +const raw = (node: ASTNode): string => node.value ?? ''; + +// 未知或降级节点的统一出口 +const passthrough = (node: ASTNode): VNode => h('span', content(node)); + +// 表格单元格对齐:与 HTML renderer 的 align 属性保持一致 +const alignAttr = (cell: ASTNode): Record => { + const align = cell.align; + return align === 'left' || align === 'center' || align === 'right' + ? { align } + : {}; +}; + +const renderTableHead = (cells?: ASTNode[]) => + cells?.length + ? h( + 'tr', + null, + cells.map((cell) => renderTableCell('th', cell)), + ) + : null; + +const renderTableBody = (rows?: ASTNode[]) => + rows?.length + ? h( + 'tbody', + null, + rows.map((row) => + h( + 'tr', + null, + (row.content ?? []).map((cell) => renderTableCell('td', cell)), + ), + ), + ) + : null; + +const renderTableCell = (tag: 'th' | 'td', cell: ASTNode): VNode => + h(tag, alignAttr(cell), content(cell)); + +export function renderToVue(nodeArray: ASTNode[]): (VNode | string)[] { + return nodeArray.map((node) => { + switch (node.type) { + // Common Flavored Markdown + case 'heading': + return h(`h${node.level}`, content(node)); + case 'paragraph': + return h('p', content(node)); + case 'text': + return raw(node); + case 'bold': + return h('strong', content(node)); + case 'italic': + return h('em', content(node)); + case 'underline': + return h('u', content(node)); + case 'strike': + return h('del', content(node)); + case 'link': { + const url = (node.url ?? '').trim(); + return h('a', { href: url }, content(node)); + } + case 'image': { + const url = (node.url ?? '').trim(); + const img = h('img', { src: url, alt: node.alt ?? '' }); + + // caption 与 title 等价;缺省时退化为裸 + const caption = node.caption ?? node.title; + if (!caption || (Array.isArray(caption) && caption.length === 0)) { + return img; + } + + const figcaption = + typeof caption === 'string' ? caption : renderToVue(caption); + + return h('figure', { class: 'ffm-image' }, [ + img, + h('figcaption', null, figcaption), + ]); + } + case 'hr': + return h('hr'); + case 'break': + return h('br'); + + case 'blockquote': + return h('blockquote', content(node)); + + case 'code': { + const language = node.lang; + // 优先取人类展示名,没有就取原始规范名 + const displayName = node.displayName || language; + + return h('div', { class: 'code-block-wrapper' }, [ + displayName ? h('div', { class: 'pre-language' }, displayName) : null, + h( + 'pre', + language + ? { 'data-language': language, 'data-async': 'hljs' } + : null, + h('code', raw(node)), + ), + ]); + } + case 'code_inline': + return h('code', raw(node)); + case 'code_color': + return h('code', { class: 'ffm-color-code' }, [ + h('span', { + class: 'ffm-color-swatch', + style: { + display: 'inline-block', + width: '0.8em', + height: '0.8em', + borderRadius: '50%', + backgroundColor: raw(node), + verticalAlign: 'middle', + marginRight: '0.3em', + border: '1px solid #00000030', + }, + }), + raw(node), + ]); + + case 'list': + return h( + node.ordered ? 'ol' : 'ul', + (node.start ?? 1) !== 1 ? { start: node.start } : null, + content(node), + ); + case 'list_item': + return h('li', content(node)); + + case 'table': + return h('div', { class: 'table-container' }, [ + h('table', null, [ + // @ts-ignore + node.header ? h('thead', null, renderTableHead(node.header)) : null, + renderTableBody(node.content), + ]), + ]); + + // Fuyeor Flavored Markdown + case 'accordion': + return h('div', { class: 'ffm-accordion' }, content(node)); + case 'accordion_item': + return h('details', { name: node.name }, [ + h('summary', renderToVue(node.title ?? [])), + h('div', { class: 'accordion-body' }, content(node)), + ]); + + case 'chain': + return h('div', { class: 'ffm-chain' }, content(node)); + case 'chain_item': { + const statusClass = node.hasCheckbox + ? node.isCompleted + ? 'is-completed' + : 'is-pending' + : ''; + return h('div', { class: ['chain-item', statusClass] }, [ + h('div', { class: 'chain-marker' }), + h('div', { class: 'chain-body' }, [ + node.title?.length + ? h('div', { class: 'chain-title' }, renderToVue(node.title)) + : null, + h('div', { class: 'chain-content' }, content(node)), + ]), + ]); + } + + case 'slide': + return h('div', { class: 'ffm-slide' }, [ + h('div', { class: 'slide-container' }, content(node)), + ]); + case 'slide_item': + return h('div', { class: 'slide-item' }, content(node)); + + // 异步节点:属性与 HTML renderer 输出完全对齐,供 hydrate() 扫描 + case 'emoji': + return h('img', { + class: 'emoji', + draggable: 'false', + alt: node.value ?? '', + src: node.src ?? '', + }); + + case 'math': + return h( + 'div', + { class: 'math-block', 'data-async': 'latex' }, + raw(node), + ); + case 'math_inline': + return h( + 'span', + { class: 'math-inline', 'data-async': 'latex' }, + raw(node), + ); + + case 'mermaid': + return h( + 'div', + { class: 'language-mermaid', 'data-async': 'mermaid' }, + raw(node), + ); + + case 'smiles': + return h( + Fragment, + null, + raw(node) + .split('\n') + .filter((line) => line.trim().length > 0) + .map((line) => + h('div', { + class: 'language-smiles smiles-block', + 'data-async': 'smiles', + 'data-smiles': line.trim(), + }), + ), + ); + case 'smiles_inline': + return h('span', { + class: 'language-smiles smiles-inline', + 'data-async': 'smiles', + 'data-smiles': raw(node), + }); + + case 'abc': + return h( + 'div', + { class: 'language-abc', 'data-async': 'abc' }, + raw(node), + ); + + default: + return passthrough(node); + } + }); +} diff --git a/package/renderer/vue/src/render.ts b/package/renderer/vue/src/render.ts deleted file mode 100644 index 8b8dbe0..0000000 --- a/package/renderer/vue/src/render.ts +++ /dev/null @@ -1,177 +0,0 @@ -// @ffm/vue-renderer/src/render.ts -import { h, type VNode } from 'vue'; -import { isSafeColorValue, isSafeLinkUrl, type ASTNode } from '@ffm/parser'; - -export function renderToVue(nodes: ASTNode[]): (VNode | string)[] { - return nodes.map((node) => { - switch (node.type) { - case 'heading': { - const level = - typeof node.level === 'number' && - Number.isInteger(node.level) && - node.level >= 1 && - node.level <= 6 - ? node.level - : null; - return level === null - ? h('span', renderToVue(node.content || [])) - : h(`h${level}`, renderToVue(node.content || [])); - } - case 'paragraph': - return h('p', renderToVue(node.content || [])); - case 'text': - return node.value || ''; // Vue 天然防 XSS,直接返回字符串 - case 'bold': - return h('strong', renderToVue(node.content || [])); - case 'italic': - return h('em', renderToVue(node.content || [])); - case 'underline': - return h('u', renderToVue(node.content || [])); - case 'strike': - return h('del', renderToVue(node.content || [])); - case 'inline_code': - return h('code', node.value || ''); - case 'color_code': { - const color = String(node.value ?? ''); - if (!isSafeColorValue(color)) return color; - return h('code', { class: 'ffm-color-code' }, [ - h('span', { - class: 'ffm-color-swatch', - style: { - display: 'inline-block', - width: '0.8em', - height: '0.8em', - borderRadius: '50%', - backgroundColor: color, - verticalAlign: 'middle', - marginRight: '0.3em', - border: '1px solid #00000030', - }, - }), - color, - ]); - } - case 'link': { - const url = String(node.url ?? '').trim(); - return isSafeLinkUrl(url) - ? h( - 'a', - { href: url, target: '_blank', rel: 'noopener noreferrer' }, - renderToVue(node.content || []), - ) - : h('span', renderToVue(node.content || [])); - } - case 'code_block': - return h('div', { class: 'code-block-wrapper' }, [ - node.lang ? h('div', { class: 'code-lang' }, node.lang) : null, - h( - 'pre', - null, - h( - 'code', - { class: node.lang ? `language-${node.lang}` : '' }, - node.value || '', - ), - ), - ]); - case 'list': - return h( - node.ordered ? 'ol' : 'ul', - node.ordered && node.start && node.start !== 1 - ? { start: node.start } - : {}, - renderToVue(node.content || []), - ); - case 'list_item': - return h('li', renderToVue(node.content || [])); - case 'table': - return h('table', null, [ - h( - 'thead', - null, - h( - 'tr', - null, - (node.header ?? []).map((cell) => - h('th', renderToVue(cell.content || [])), - ), - ), - ), - node.content && node.content.length > 0 - ? h( - 'tbody', - null, - node.content.map((row) => - h( - 'tr', - null, - (row.content ?? []).map((cell) => - h('td', renderToVue(cell.content || [])), - ), - ), - ), - ) - : null, - ]); - case 'hr': - return h('hr'); - case 'blockquote': - return h('blockquote', renderToVue(node.content || [])); - case 'hardbreak': - return h('br'); - case 'accordion': - return h( - 'div', - { class: 'ffm-accordion' }, - renderToVue(node.content || []), - ); - case 'accordion_item': - return h('details', { name: node.name }, [ - h('summary', renderToVue(node.title || [])), - h( - 'div', - { class: 'accordion-content' }, - renderToVue(node.content || []), - ), - ]); - case 'chain': - return h( - 'div', - { class: 'chain-container' }, - renderToVue(node.content || []), - ); - case 'chain_item': { - const statusClass = node.hasCheckbox - ? node.isCompleted - ? 'is-completed' - : 'is-pending' - : ''; - return h('div', { class: ['chain-item', statusClass] }, [ - h('div', { class: 'chain-marker' }), - h('div', { class: 'chain-content-wrapper' }, [ - node.title && node.title.length > 0 - ? h('div', { class: 'chain-title' }, renderToVue(node.title)) - : null, - h('div', { class: 'chain-body' }, renderToVue(node.content || [])), - ]), - ]); - } - case 'slide': - return h('div', { class: 'slide-container-wrapper' }, [ - h( - 'div', - { class: 'slide-container' }, - renderToVue(node.content || []), - ), - ]); - case 'slide_item': - return h( - 'div', - { class: 'slide-item' }, - renderToVue(node.content || []), - ); - default: - return h('span', renderToVue(node.content || [])); - } - }); -} diff --git a/playground/index.html b/playground/index.html index 2fb01b1..2f49fe8 100644 --- a/playground/index.html +++ b/playground/index.html @@ -60,6 +60,8 @@ + diff --git a/playground/public/static/css/style.css b/playground/public/static/css/style.css index 9387a74..1b3bab2 100644 --- a/playground/public/static/css/style.css +++ b/playground/public/static/css/style.css @@ -114,6 +114,24 @@ body { .right-sidebar { padding: 20px 0 30px 20px; + height: 100vh; + max-height: 100dvh; +} + +/* 让中间的包裹层能撑满并允许内部收缩 */ +#sidebar-wrapper { + flex: 1 1 auto; + min-height: 0; + display: flex; + flex-direction: column; +} + +/* article.preview 成为纵向 flex 容器 */ +.right-sidebar article.section.preview { + flex: 1 1 auto; + min-height: 0; + display: flex; + flex-direction: column; } @media (width >= 1000px) { diff --git a/playground/src/@app/component/right.vue b/playground/src/@app/component/right.vue index def06e3..1537afc 100644 --- a/playground/src/@app/component/right.vue +++ b/playground/src/@app/component/right.vue @@ -3,10 +3,40 @@ + + diff --git a/playground/src/document/component/preview.vue b/playground/src/document/component/preview.vue index a3bcef0..d03eeb7 100644 --- a/playground/src/document/component/preview.vue +++ b/playground/src/document/component/preview.vue @@ -19,16 +19,23 @@