首页
/ Eleventy 3.0 新特性:配置文件中的 config 命名导出

Eleventy 3.0 新特性:配置文件中的 config 命名导出

2025-05-12 04:45:22作者:蔡怀权

Eleventy 作为一款流行的静态站点生成器,在即将发布的 3.0 版本中引入了一项重要改进:通过配置文件中的 config 命名导出来设置项目配置。这一变化为开发者提供了更清晰、更灵活的配置方式。

配置方式的演进

在 Eleventy 的发展过程中,配置方式经历了多次迭代:

  1. 最初通过配置回调函数返回的对象设置
  2. 后来增加了 set*Directory 方法
  3. 现在引入了 config 命名导出

这种演进使得配置更加模块化和可维护,特别是对于大型项目而言。

新的配置方式详解

新的 config 命名导出方式允许开发者在配置文件中同时导出配置函数和配置对象:

// ESM 方式
export default function(eleventyConfig) {
  // 配置逻辑
};

export const config = {
  dir: {
    input: "content",
    output: "_site"
  }
}
// CommonJS 方式
module.exports = function(eleventyConfig) {
  // 配置逻辑
};

module.exports.config = {
  dir: {
    input: "content",
    output: "_site"
  }
}

配置优先级规则

Eleventy 3.0 明确了配置的优先级顺序:

  1. 命令行参数(如 --input--output)具有最高优先级
  2. 配置回调函数返回对象中的 dir 属性
  3. set*Directory 配置 API 方法
  4. 新的 config 导出中的配置

这种明确的优先级规则有助于开发者理解配置的生效顺序,避免混淆。

最佳实践建议

Eleventy 团队建议开发者优先使用新的 config 命名导出方式,原因包括:

  1. 配置与逻辑分离,代码更清晰
  2. 便于静态分析和工具支持
  3. 与未来发展方向保持一致
  4. 减少对配置回调函数返回对象的依赖

向后兼容性

考虑到现有项目,Eleventy 3.0 保持了良好的向后兼容性。所有现有的配置方式仍然有效,但新项目推荐使用新的 config 导出方式。

这项改进是 Eleventy 3.0 版本众多优化中的一部分,展示了项目对开发者体验的持续关注。通过这种更清晰的配置方式,开发者可以更高效地管理和维护他们的静态站点项目。

登录后查看全文
热门项目推荐
相关项目推荐