Marked.js 中关于自定义钩子函数的正确使用方式

在 Marked.js 这个流行的 Markdown 解析库中，开发者经常会遇到需要自定义解析过程的需求。本文深入探讨了如何正确地在 Marked.js 中使用自定义钩子函数，以及为什么某些使用方式会导致错误。

问题背景

当开发者尝试仅提供部分钩子函数（hooks）时，直接将这些钩子作为选项传递给 marked.parse() 方法会导致错误。具体表现为系统会抛出 TypeError，提示缺少 provideLexer 或 provideParser 函数。

错误原因分析

Marked.js 的设计哲学是鼓励开发者在初始化阶段就完成所有配置，而不是在每次解析时动态修改。这种设计基于性能考虑：

1. 性能优化：marked.use() 方法内部处理选项合并和扩展的逻辑较为复杂，如果在循环中频繁调用会导致性能下降
2. 一致性保证：通过强制在初始化阶段完成配置，可以确保解析行为的一致性

正确使用方式

方法一：使用 marked.use()

import { marked } from "marked";

marked.use({
  hooks: {
    postprocess: (html) => html
  }
});

console.log(marked("# Test")); // 正确输出 <h1>Test</h1>

方法二：创建多个 Marked 实例

如果需要根据不同情况使用不同的钩子配置，可以创建多个 Marked 实例：

import { Marked } from 'marked';

const marked1 = new Marked({
  hooks: {
    postprocess: (html) => html + " from marked1"
  }
});

const marked2 = new Marked({
  hooks: {
    postprocess: (html) => html + " from marked2"
  }
});

技术原理

Marked.js 内部实现中，当检测到 hooks 选项时，会严格检查是否同时提供了完整的钩子函数集合。这是为了确保解析过程的完整性，避免因部分钩子缺失导致不可预期的行为。

最佳实践建议

1. 初始化阶段完成配置：尽量在应用启动时通过 marked.use() 完成所有配置
2. 避免动态修改：不要在循环或频繁调用的函数中修改解析配置
3. 多实例方案：对于确实需要不同配置的场景，使用多个 Marked 实例而非动态修改

通过遵循这些原则，开发者可以充分利用 Marked.js 的性能优势，同时实现灵活的自定义解析需求。