首页
/ EventCatalog项目中trailingSlash配置导致变更日志链接错误的解决方案

EventCatalog项目中trailingSlash配置导致变更日志链接错误的解决方案

2025-07-04 05:19:22作者:温艾琴Wonderful

在EventCatalog项目使用过程中,当配置了trailingSlash=true时,系统生成的变更日志(Changelog)按钮链接会出现错误。这个问题主要影响版本控制文档的导航体验。

问题现象分析

当用户在EventCatalog项目中启用trailingSlash配置后,系统会生成两种不同的变更日志链接:

  1. 正确的"View changelogs"链接格式: /docs/events/InventoryAdjusted/1.0.1/changelog/

  2. 错误的"Changelog"按钮链接格式: /docs/events/InventoryAdjusted/1.0.1/1.0.1/changelog/

从技术角度看,这个问题源于两种链接生成机制的不同实现方式:

  • "View changelogs"链接采用完整URL构建方式
  • "Changelog"按钮则使用了相对路径的拼接方式

问题根源

在React路由和Next.js框架中,trailingSlash配置会影响路由的匹配和链接生成行为。当启用该选项时,系统会自动在所有路由路径末尾添加斜杠。然而,在EventCatalog的实现中,部分组件没有完全适配这种路由格式的变化,导致路径拼接时出现了重复的版本号段。

解决方案

项目维护团队在@eventcatalog/core@2.2.3版本中修复了这个问题。修复方案主要涉及:

  1. 统一链接生成逻辑,确保所有变更日志链接都采用一致的构建方式
  2. 适配trailingSlash配置,正确处理路径末尾的斜杠
  3. 避免路径拼接时的重复段问题

最佳实践建议

对于使用EventCatalog的开发者,建议:

  1. 及时升级到最新版本的@eventcatalog/core包
  2. 在配置trailingSlash时,全面测试所有导航链接
  3. 对于自定义组件,确保使用项目提供的统一链接生成工具方法

这个问题的修复体现了EventCatalog项目对细节的关注和对用户体验的重视,也提醒我们在处理路由配置时要考虑各种边界情况。

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