Eleventy 3.0中Nunjucks短代码定义错误的诊断与修复

在Eleventy 3.0.0-alpha版本中，当开发者尝试使用Nunjucks模板引擎时，可能会遇到一个令人困惑的错误："callback.call is not a function"。这个错误通常发生在定义和使用Nunjucks短代码(Shortcode)时，特别是当开发者从ESM模块导入短代码函数时处理不当的情况下。

错误现象分析

当开发者使用Eleventy 3.0.0-alpha.10版本时，编译Nunjucks模板文件(.njk扩展名)可能会失败，并显示上述错误。错误堆栈会指向模板文件的某一行，但实际上问题根源在于短代码的定义方式。

错误的关键特征包括：

• 错误信息指向Nunjucks模板文件，但行号可能不准确
• 仅影响.njk扩展名的文件，而.md文件即使使用Nunjucks也可能不受影响
• 错误信息中提到的"callback.call"是Eleventy内部处理短代码时的调用机制

问题根源

经过Eleventy核心团队的诊断，发现问题出在ESM模块导入短代码函数时的处理方式。在Eleventy配置文件中，开发者可能使用了类似以下的代码：

eleventyConfig.addPairedNunjucksShortcode(
    "callout",
    import("./config/shortcodes/callout.js")
);

这种写法的问题在于：

1. import()返回的是一个Promise对象，而不是直接的函数
2. 即使Promise解析后，得到的模块对象需要访问其default属性才能获取导出的函数

解决方案

有两种推荐的修正方法：

方法一：使用await和.default

eleventyConfig.addPairedNunjucksShortcode(
    "callout",
    (await import("./config/shortcodes/callout.js")).default
);

这种方法直接解决了Promise和模块导出结构的问题。

方法二：分离导入和使用（推荐）

更清晰和可维护的方式是将导入和使用分开：

import calloutShortcode from "./config/shortcodes/callout.js";

export default async function(eleventyConfig) {
    eleventyConfig.addPairedNunjucksShortcode("callout", calloutShortcode);
};

这种方式：

1. 更清晰地分离了关注点
2. 代码更易读和维护
3. 减少了嵌套层次

Eleventy的改进

Eleventy团队在3.0.0-alpha.15版本中改进了错误提示，当遇到无效的短代码定义时，会显示更友好的错误信息：

[11ty] 1. Error in your Eleventy config file '.eleventy.js'. (via EleventyConfigError)
[11ty] 2. Invalid definition for "callout" Nunjucks Paired Shortcode. (via Error)

这种改进帮助开发者更快定位问题所在，而不是被内部实现细节所困扰。

最佳实践建议

1. 模块导入清晰化：始终明确区分模块导入和短代码注册
2. 类型检查：在复杂项目中，可以考虑添加类型检查确保传入的是有效函数
3. 版本注意：使用Eleventy 3.0.0-alpha.15或更高版本以获得更好的错误提示
4. 代码组织：将短代码函数单独放在模块中，保持配置文件的简洁性

通过遵循这些实践，开发者可以避免此类问题，并构建更健壮的Eleventy项目结构。