首页
/ EventCatalog自动生成文档功能对子目录结构的支持优化

EventCatalog自动生成文档功能对子目录结构的支持优化

2025-07-04 14:45:20作者:毕习沙Eudora

在EventCatalog项目中,自动生成文档功能(Autogenerated)目前存在一个重要的使用限制:当目标目录的子项是文件夹而非文件时,该功能将无法正常工作。这一限制影响了项目在实际场景中的灵活应用。

问题背景

EventCatalog是一个事件驱动架构的文档工具,其自动生成文档功能原本设计用于处理包含Markdown文件的目录结构。但在实际应用中,用户经常需要组织更复杂的文档结构,其中包含多层嵌套的文件夹。例如:

events/
  ├── payment/
  │   ├── PaymentCompleted/
  │   │   ├── index.md
  │   │   └── schema.json
  │   └── PaymentFailed/
  │       ├── index.md
  │       └── schema.json
  └── order/
      ├── OrderCreated/
      │   ├── index.md
      │   └── schema.json
      └── OrderCancelled/
          ├── index.md
          └── schema.json

在这种结构中,payment和order是顶级分类,而PaymentCompleted等是具体的事件类型。现有的自动生成功能无法正确处理这种包含子目录的结构。

技术实现考量

要让EventCatalog支持文件夹结构的自动生成,需要考虑以下几个技术点:

  1. 递归目录遍历:需要实现深度优先或广度优先的目录遍历算法,确保能发现所有层级的文档文件。

  2. 侧边栏菜单生成:需要根据目录结构自动生成多级菜单,保持与文件系统结构的一致性。

  3. 配置验证:现有的配置验证逻辑需要扩展,以支持包含子目录的配置项。

  4. 性能优化:对于大型项目,需要考虑目录遍历的性能影响,可能需要实现缓存机制。

解决方案设计

理想的解决方案应该:

  1. 修改目录扫描逻辑,使其能够递归处理子目录
  2. 为每个发现的子目录生成对应的菜单项
  3. 保持向后兼容,不影响现有仅包含文件的目录结构
  4. 提供配置选项控制递归深度或排除特定目录

实际应用价值

这一改进将带来以下好处:

  1. 更自然的文档组织结构,符合用户对分类的直觉
  2. 支持大型项目的文档管理,可以按功能域/业务域分层组织
  3. 减少手动配置的工作量,提高文档系统的可维护性
  4. 为未来可能的团队协作功能奠定基础

总结

EventCatalog对子目录结构的支持是其作为专业文档工具的重要进化。这一改进不仅解决了当前的使用限制,更为项目的未来发展开辟了更多可能性。通过合理的递归处理和菜单生成算法,EventCatalog可以更好地服务于复杂的企业级应用场景。

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