Skip to content

更新: 9/23/2024 字数: 0 字 时长: 0 分钟

开发 Annotree 的故事

本项目基于 folder-explorer 进行二次开发,🙏🏻 非常感谢 FairyEver 的创意和贡献!

起源

  • 2023 年 6 月,我负责搭建公司内部的前端基础框架。在框架搭建完成后,我希望为框架的目录结构编写注释,以便其他团队成员能快速理解框架的结构。
  • 我了解到 tree 命令可以扫描项目目录结构,但它仅能生成目录结构,注释编写和对齐仍需手动调整,非常不便。
  • 于是,我继续寻找相关工具,发现了 folder-explorer。这个工具提供了目录注释编写及对齐功能,使用起来相当方便。
  • 不过,folder-explorer 仍然无法完全满足我的需求,因此我决定在其基础上进行二次开发,创建了 Annotree。
  • 其实,我原计划在 2024 年 3 月就开始二次开发,但由于当时忙于其他事务且对 Electron 相关 API 不够熟悉,开发工作一直拖到 2024 年 7 月才开始。

为何二次开发

  1. folder-explorer 的某些功能对我来说不必要,显得有些冗余,且不符合我的使用习惯。
  2. folder-explorer 需要导出后才能看到配置后的效果,我希望能够实现实时预览功能。
  3. folder-explorer 中编辑备注时,每次都需右键打开编辑菜单,这种操作方式不够方便。

基于 MIT 许可发布.