提高生产效率是人类永恒的追求，代码阅读器就是提效工具。

背景

如开题所述，代码阅读器是开发者的砍柴刀。但业界知名的 Source Insight / SourceTrail / Understand 都不支持 iOS 领域语言。有些脚本^[1]在尝试做这些事情，效果并不理想。

不用代码阅读器也可过活，UML / 时序图 / 注释和文档 等工具的加持也勉强可用，但面对大型复杂项目，这些仍显得杯水车薪。

解决思路

通过分析静态产物洞察代码，基于 LSP^[2] 做为代码和可视化产物的中介。

方案选型

可视化意味着需要有 GUI ，首先想到的是基于 VS Code 生态做插件。 VS Code 插件原理简单，yo/vsce脚手架也很成熟，但是 NodeJS / JavaScript 并不兼容 Swift 解释器并且业界没有其他三方解释器支持。其次考虑到 SourceTrail 是开源且可通过 SourceTrailDB 自定义扩展语言包。所以接下来的任务就是考虑选用合适的索引解释器。

GUI方案

1. VS Code
2. SourceTrail：QT项目
3. CodeEditor：仅支持MacOS。社区维护的开源项目，活跃且完成度高
4. flutter-ide：跨端。star最多的flutter项目，但是已经不维护

GUI 方案先待定，参考了 VS Code 插件、SourceTrail、CodeEdit 等 Github IDE排名前十的方案，看了源码后深感这是一个投入很重领域，在原生或是跨段方案上还有顾虑。而在确认函数调用关系任务前， GUI 先放一放。

SwiftSyntax 是 iOS 官方提供的静态语言工具库，其中的语义分析工具可以把代码生成 AST^[3]，
通过对 AST 的窥察，可以生成 UML 类图，但这仍然不够。我们需要 模块 / 文件 / 类 / 方法 的关系，最好还能区分主干和分支路径^桑基图。SourceKit 可以基于 Sematic 提供更多额外的信息。IndexStore-DB做Index，服务于SourceKit-LSP。

另外，关键信息的提取、总结、生成、分类、检索与改写六部分，最好需要AI模型的支持。

收益

GUI 和 CLI 针对不同场景使用。

1. 阅读/诊断代码
2. 代码质量报告

功能

1. 基础：UML / Hierarchy /
2. 调用权重：区分逻辑的主干、分支
3. ……

可以简单分享一下我的想法。初代应该会基于 SourceTrail 做扩展，后续会独立出来做二次开发。
主要功能会围绕代码效率以及赋予交互的乐趣。

好了，方向和思路基本有了，还需进一步想想……

待完善的思路

1. SourceKit-LSP 项目还处在早期，index只支持 indexing while building，还不支持 background index。关于项目的自我解释感到很困惑，Xcode 的代码跳转或是补全，并没有必须要先build啊，Xcode和Sourcekit-lsp 有什么关系，Xcode 的 indexing 时机是啥？

1. Sourcekit-lsp 只支持SPM 不支持 Xcode: You can use sourcekit-lsp with Swift packages but not (yet) with Xcode projects.

2. How LSP server & client & editor works together？

参考

1. [1]. Swift自动生成UML类图
2. [2]. sourcekit-lsp
3. [3]. swift-ast-explorer