Modern.js 项目中如何正确配置 HTML 输出路径

在 Modern.js 项目中，开发者经常需要自定义 HTML 文件的输出路径，特别是当需要将构建产物集成到后端服务（如 Golang 或 Nginx）时。本文将详细介绍如何正确配置 Modern.js 以实现理想的 HTML 文件输出结构，同时避免常见的路由失效问题。

典型需求场景

许多开发者希望 Modern.js 构建后生成的 HTML 文件直接位于 dist 目录下，而不是嵌套在 html/main 子目录中。这种需求常见于以下场景：

1. 将前端构建产物直接部署到 Nginx 等 Web 服务器
2. 将前端资源集成到 Golang、Java 等后端服务的静态资源目录
3. 简化部署流程，保持与传统前端项目一致的目录结构

正确配置方案

要实现 HTML 文件直接输出到 dist 根目录，同时保持路由功能正常，需要使用以下 Modern.js 配置组合：

export default defineConfig({
  output: {
    distPath: {
      html: '', // 将 HTML 文件输出到 dist 根目录
    },
  },
  source: {
    mainEntryName: 'index', // 指定主入口名称为 index
  },
  html: {
    disableHtmlFolder: true, // 禁用 HTML 文件夹嵌套
  },
})

这个配置会产生如下构建目录结构：

dist
├─index.html
└─static

常见错误配置

开发者可能会尝试使用 output.filename 配置来重命名 HTML 文件，但这种做法会导致自动路由功能失效：

// 错误配置示例 - 会导致路由404
output: {
  filename: {
    html: 'index.html', // 这种配置会破坏路由系统
  },
}

配置原理分析

1. distPath.html：控制 HTML 文件的输出目录，设置为空字符串表示输出到 dist 根目录
2. mainEntryName：指定主入口文件名，设置为 'index' 会生成 index.html
3. disableHtmlFolder：禁用 Modern.js 默认的 HTML 文件夹嵌套结构

Modern.js 的路由系统依赖于特定的文件命名约定，直接修改 output.filename 会破坏这种约定，导致开发服务器无法正确匹配路由规则。

最佳实践建议

1. 对于需要与后端集成的项目，推荐使用本文提供的正确配置方案
2. 避免直接修改 output.filename.html 配置，除非你完全理解其对路由系统的影响
3. 在调整 HTML 输出配置后，务必测试所有路由是否正常工作
4. 对于复杂的部署需求，可以考虑使用 Modern.js 的部署插件或自定义部署脚本

通过理解这些配置项的作用原理，开发者可以更灵活地控制 Modern.js 项目的构建输出，同时避免常见的路由失效问题。