首页
/ 探索与记录Clojure/ClojureScript代码的神奇工具 —— Clograms

探索与记录Clojure/ClojureScript代码的神奇工具 —— Clograms

2024-06-02 01:07:02作者:幸俭卉

Clograms 是一个创新的开源项目,它致力于通过图表来探索和记录你的Clojure或ClojureScript项目。这个工具将代码和图表紧密结合起来,让你的系统架构清晰可见。

当你面对一个陌生的代码库,或是想要为自己的项目构建高层次的架构文档时,代码图谱的作用不言而喻。Clograms 正是为了这些任务而生,它将图示化工具的强大视觉展示功能与IDE的导航和探索特性巧妙融合。

一睹风采

查看以下截图,感受一下Cloggrams 的魅力:

探索与记录Clojure/ClojureScript代码的神奇工具 —— Clograms 探索与记录Clojure/ClojureScript代码的神奇工具 —— Clograms

强大特性

  • 扫描和索引:支持lein和deps.edn项目的快速扫描和索引。
  • 绘制图表:利用项目实体(如项目、命名空间、变量、规格等)创建图表。
  • 绘制形状:辅助解释或描述系统的任何部分。
  • 链接实体:表达实体之间的关系。
  • 快速搜索任何系统实体并添加到图表中。
  • 使用项目浏览器轻松探索你的系统及其依赖。
  • 通过源代码导航轻松添加更多实体。
  • 查看多方法实现函数规格
  • 一键获取函数的引用、协议或多方法信息。
  • 辅助识别未被调用的库函数,了解其预期API。
  • 与re-frame框架兼容:快速探索订阅、事件、fx和cofx。
  • 热代码重载:修改clj, cljs或cljc文件后,变更会自动同步到UI。
  • 保存和分享你的图表为.edn文件。

演示体验

精彩演示视频即将上线,敬请期待!

马上试用!

Clograms 已经作为Clojars上的Maven artifact发布,最新版本是:Clojars Project

安装步骤

确保安装了Clojure CLI工具,然后使用以下命令对Clojure或ClojureScript项目进行索引:

clj -Sforce -Sdeps '{:deps {com.github.jpmonettas/clograms {:mvn/version "RELEASE"}}}' -M -m clograms.server --platform <平台> <项目目录>

其中 <平台> 可以是 cljcljs

完成索引后,访问 http://localhost:3000 即可加载图表。为了更好的浏览体验,可以在浏览器中启用"应用模式",例如 google-chrome --app=http://localhost:3000

查看所有支持的选项,请运行:

clj -Sdeps '{:deps {com.github.jpmonettas/clograms {:mvn/version "RELEASE"}}}' -M -m clograms.server --help

微型手册

  • 搜索:顶部栏可以用于添加节点,只要记得函数名、命名空间或其他项目实体,输入即可。
  • 节点:右侧面板提供了各种类型节点,拖放至图表中,所有节点都支持右键菜单删除,可以过滤显示特定类型的节点。
  • 形状节点:支持圆形、矩形、数据库、分组和用户形状,可调整大小,右键菜单选择“编辑文本”更改标签。
  • 链接:按住鼠标从一个节点端口拖动到另一个端口创建链接,方向可调整,双击链接端点添加新节点。
  • 函数和变量节点:右键点击任何函数调用链接,会在其前添加函数节点。右键点击节点使用“查找引用”,双击参考直接添加节点。
  • 色彩:源代码节点右键菜单可设置所属项目或命名空间颜色。
  • 保存和恢复:点击UI中的保存按钮将图表保存在运行目录下的diagram.edn 文件,下次加载时自动读取。

开发者信息

Clograms 基于 clindex,一个Clojure[Script]源代码索引器。

路线图

详情见 GitHub Issues 中的标记为"enhancement"的项。

相关工作

不要犹豫,立即尝试Clograms ,让图表成为你理解、记录和分享Clojure/ClojureScript项目的新方式!

登录后查看全文

项目优选

收起
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
51
15
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
536
407
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
63
145
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
121
207
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
400
37
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
297
1.03 K
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
98
252
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
358
342
CS-BooksCS-Books
🔥🔥超过1000本的计算机经典书籍、个人笔记资料以及本人在各平台发表文章中所涉及的资源等。书籍资源包括C/C++、Java、Python、Go语言、数据结构与算法、操作系统、后端架构、计算机系统知识、数据库、计算机网络、设计模式、前端、汇编以及校招社招各种面经~
58
7
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
51
55