11ty项目中实现JSX/TSX模板渲染的进阶方案

在11ty静态网站生成器中，开发者经常需要扩展其模板引擎功能来支持现代前端开发技术。本文将深入探讨如何在11ty项目中实现JSX/TSX模板渲染的完整解决方案，特别是针对与eleventy-img插件配合使用时出现的常见问题。

背景与挑战

11ty默认支持多种模板语言，但原生并不直接支持JSX/TSX。开发者通常通过配置扩展来实现这一功能，常见做法是使用addExtension方法扩展JavaScript模板引擎，然后通过addTransform将JSX对象渲染为HTML字符串。

然而，当与eleventy-img等插件配合使用时，会出现执行顺序问题：图片插件的HTML转换器会先于自定义的JSX转换器执行，导致JSX对象被错误地转换为[object Object]字符串，从而丢失原始JSX内容。

解决方案演进

初始方案：使用Transform转换

最初的解决方案采用了两步配置：

1. 通过addExtension扩展模板类型
2. 使用addTransform将JSX渲染为HTML

这种方法虽然简单，但存在执行顺序问题，且性能不是最优。

进阶方案：直接扩展编译过程

更优雅的解决方案是直接扩展模板引擎的编译过程，在编译阶段就完成JSX到HTML的转换。11ty在3.0.0-alpha.11版本中增强了addExtension功能，允许在扩展内置语法时定义完整的编译流程。

核心配置如下：

eleventyConfig.addExtension(["11ty.jsx", "11ty.ts", "11ty.tsx"], {
  key: "11ty.js",
  read: false,
  compile: function() {
    return async function(data) {
      let content = await this.defaultRenderer(data);
      return renderToString(content);
    };
  }
});

这种方案具有以下优势：

• 避免转换器执行顺序问题
• 性能更优，直接在编译阶段完成转换
• 更符合11ty的设计哲学

完整实现细节

1. 环境准备

首先需要配置TypeScript/JSX运行环境。推荐使用tsx运行时，可以通过以下命令启动11ty：

NODE_OPTIONS='--import tsx/esm' npx @11ty/eleventy

2. 模板文件结构

TSX模板文件应遵循以下结构：

import React from "react";

function render(data: object) {
  return <div>hello</div>;
}

export { render }

3. 编译过程解析

当11ty处理TSX文件时：

1. 通过defaultRenderer获取原始渲染结果
2. 使用renderToString将JSX转换为HTML字符串
3. 直接输出最终HTML，无需后续转换

4. 与其他插件的兼容性

这种方案天然解决了与eleventy-img等插件的兼容问题，因为：

• 输出已经是纯HTML字符串
• 不再有中间JSX对象阶段
• 插件可以正常处理最终的HTML内容

最佳实践建议

1. 版本要求：确保使用11ty 3.0.0-alpha.11或更高版本
2. 类型安全：为render函数添加完整的TypeScript类型定义
3. 组件组织：将复杂UI拆分为可复用组件
4. 性能优化：考虑对静态内容使用React.memo
5. 错误处理：在compile函数中添加适当的错误处理逻辑

总结

通过直接扩展11ty的编译过程来实现JSX/TSX支持，不仅解决了与其他插件的兼容性问题，还提供了更高效、更符合工程化要求的解决方案。这种方法充分利用了11ty的扩展能力，同时保持了与现代前端开发实践的兼容性，是构建复杂静态网站的推荐方案。