提高生產(chǎn)效率是人類永恒的追求笋鄙，代碼閱讀器就是提效工具。
背景
如開題所述，代碼閱讀器是開發(fā)者的砍柴刀考抄。但業(yè)界知名的 Source Insight / SourceTrail / Understand 都不支持 iOS 領(lǐng)域語言渗勘。有些腳本[1]在嘗試做這些事情沐绒，效果并不理想。
不用代碼閱讀器也可過活旺坠，UML / 時序圖 / 注釋和文檔 等工具的加持也勉強(qiáng)可用乔遮，但面對大型復(fù)雜項目，這些仍顯得杯水車薪取刃。
解決思路
通過分析靜態(tài)產(chǎn)物洞察代碼蹋肮，基于 LSP[2] 做為代碼和可視化產(chǎn)物的中介。
方案選型
可視化意味著需要有 GUI 璧疗，首先想到的是基于 VS Code 生態(tài)做插件坯辩。 VS Code 插件原理簡單，yo/vsce腳手架也很成熟崩侠，但是 NodeJS / JavaScript 并不兼容 Swift 解釋器并且業(yè)界沒有其他三方解釋器支持漆魔。其次考慮到 SourceTrail 是開源且可通過 SourceTrailDB 自定義擴(kuò)展語言包。所以接下來的任務(wù)就是考慮選用合適的索引解釋器。
GUI方案
- VS Code
- SourceTrail：QT項目
- CodeEditor：僅支持MacOS改抡。社區(qū)維護(hù)的開源項目矢炼，活躍且完成度高
- flutter-ide：跨端。star最多的flutter項目阿纤，但是已經(jīng)不維護(hù)
GUI 方案先待定句灌，參考了 VS Code 插件、SourceTrail欠拾、CodeEdit 等 Github IDE排名前十的方案胰锌，看了源碼后深感這是一個投入很重領(lǐng)域，在原生或是跨段方案上還有顧慮清蚀。而在確認(rèn)函數(shù)調(diào)用關(guān)系任務(wù)前匕荸， GUI 先放一放。
SwiftSyntax 是 iOS 官方提供的靜態(tài)語言工具庫枷邪，其中的語義分析工具可以把代碼生成 AST[3]榛搔，
通過對 AST 的窺察，可以生成 UML 類圖东揣，但這仍然不夠践惑。我們需要 模塊 / 文件 / 類 / 方法 的關(guān)系，最好還能區(qū)分主干和分支路徑伤晃裕基圖尔觉。SourceKit 可以基于 Sematic 提供更多額外的信息。IndexStore-DB做Index芥吟，服務(wù)于SourceKit-LSP侦铜。
另外，關(guān)鍵信息的提取钟鸵、總結(jié)钉稍、生成、分類棺耍、檢索與改寫六部分贡未，最好需要AI模型的支持。
收益
GUI 和 CLI 針對不同場景使用蒙袍。
- 閱讀/診斷代碼
- 代碼質(zhì)量報告
功能
- 基礎(chǔ)：UML / Hierarchy /
- 調(diào)用權(quán)重：區(qū)分邏輯的主干俊卤、分支
- ……
可以簡單分享一下我的想法。初代應(yīng)該會基于 SourceTrail 做擴(kuò)展害幅，后續(xù)會獨(dú)立出來做二次開發(fā)消恍。
主要功能會圍繞代碼效率以及賦予交互的樂趣。
好了以现，方向和思路基本有了狠怨，還需進(jìn)一步想想……
待完善的思路
- SourceKit-LSP 項目還處在早期佩抹，index只支持 indexing while building，還不支持 background index取董。關(guān)于項目的自我解釋感到很困惑，Xcode 的代碼跳轉(zhuǎn)或是補(bǔ)全无宿，并沒有必須要先build啊茵汰，Xcode和Sourcekit-lsp 有什么關(guān)系，Xcode 的 indexing 時機(jī)是啥孽鸡？
- Sourcekit-lsp 只支持SPM 不支持 Xcode: You can use
sourcekit-lspwith Swift packages but not (yet) with Xcode projects.
- How LSP server & client & editor works together蹂午？
參考
- [1]. Swift自動生成UML類圖
- [2]. sourcekit-lsp
- [3]. swift-ast-explorer
