代码阅读器

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

背景

如开题所述,代码阅读器是开发者的砍柴刀。但业界知名的 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.
  1. How LSP server & client & editor works together?

参考

  1. [1]. Swift自动生成UML类图
  2. [2]. sourcekit-lsp
  3. [3]. swift-ast-explorer
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 160,165评论 4 364
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,720评论 1 298
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,849评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,245评论 0 213
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,596评论 3 288
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,747评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,977评论 2 315
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,708评论 0 204
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,448评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,657评论 2 249
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,141评论 1 261
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,493评论 3 258
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,153评论 3 238
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,108评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,890评论 0 198
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,799评论 2 277
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,685评论 2 272

推荐阅读更多精彩内容