探索与记录Clojure/ClojureScript代码的神奇工具 —— Clograms
2024-06-02 01:07:02作者:幸俭卉
Clograms 是一个创新的开源项目,它致力于通过图表来探索和记录你的Clojure或ClojureScript项目。这个工具将代码和图表紧密结合起来,让你的系统架构清晰可见。
当你面对一个陌生的代码库,或是想要为自己的项目构建高层次的架构文档时,代码图谱的作用不言而喻。Clograms 正是为了这些任务而生,它将图示化工具的强大视觉展示功能与IDE的导航和探索特性巧妙融合。
一睹风采
查看以下截图,感受一下Cloggrams 的魅力:
强大特性
- 扫描和索引:支持lein和deps.edn项目的快速扫描和索引。
- 绘制图表:利用项目实体(如项目、命名空间、变量、规格等)创建图表。
- 绘制形状:辅助解释或描述系统的任何部分。
- 链接实体:表达实体之间的关系。
- 快速搜索任何系统实体并添加到图表中。
- 使用项目浏览器轻松探索你的系统及其依赖。
- 通过源代码导航轻松添加更多实体。
- 查看多方法实现和函数规格。
- 一键获取函数的引用、协议或多方法信息。
- 辅助识别未被调用的库函数,了解其预期API。
- 与re-frame框架兼容:快速探索订阅、事件、fx和cofx。
- 热代码重载:修改clj, cljs或cljc文件后,变更会自动同步到UI。
- 保存和分享你的图表为.edn文件。
演示体验
精彩演示视频即将上线,敬请期待!
马上试用!
Clograms 已经作为Clojars上的Maven artifact发布,最新版本是:
安装步骤
确保安装了Clojure CLI工具,然后使用以下命令对Clojure或ClojureScript项目进行索引:
clj -Sforce -Sdeps '{:deps {com.github.jpmonettas/clograms {:mvn/version "RELEASE"}}}' -M -m clograms.server --platform <平台> <项目目录>
其中 <平台>
可以是 clj
或 cljs
。
完成索引后,访问 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"的项。
相关工作
- FC4框架:软件架构图C4框架。
不要犹豫,立即尝试Clograms ,让图表成为你理解、记录和分享Clojure/ClojureScript项目的新方式!
登录后查看全文
热门项目推荐
cherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端TypeScript037RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统Vue0407arkanalyzer
方舟分析器:面向ArkTS语言的静态程序分析框架TypeScript040GitCode百大开源项目
GitCode百大计划旨在表彰GitCode平台上积极推动项目社区化,拥有广泛影响力的G-Star项目,入选项目不仅代表了GitCode开源生态的蓬勃发展,也反映了当下开源行业的发展趋势。03CS-Books
🔥🔥超过1000本的计算机经典书籍、个人笔记资料以及本人在各平台发表文章中所涉及的资源等。书籍资源包括C/C++、Java、Python、Go语言、数据结构与算法、操作系统、后端架构、计算机系统知识、数据库、计算机网络、设计模式、前端、汇编以及校招社招各种面经~07openGauss-server
openGauss kernel ~ openGauss is an open source relational database management systemC++0145
热门内容推荐
1 freeCodeCamp论坛排行榜项目中的错误日志规范要求2 freeCodeCamp英语课程视频测验选项与提示不匹配问题分析3 freeCodeCamp课程页面空白问题的技术分析与解决方案4 freeCodeCamp课程视频测验中的Tab键导航问题解析5 freeCodeCamp全栈开发课程中React组件导出方式的衔接问题分析6 freeCodeCamp全栈开发课程中React实验项目的分类修正7 freeCodeCamp英语课程填空题提示缺失问题分析8 freeCodeCamp Cafe Menu项目中link元素的void特性解析9 freeCodeCamp课程中屏幕放大器知识点优化分析10 freeCodeCamp JavaScript高阶函数中的对象引用陷阱解析
最新内容推荐
Visual-RFT项目中模型路径差异的技术解析 Microcks在OpenShift上部署Keycloak PostgreSQL的权限问题解析 Beyla项目中的HTTP2连接检测问题解析 RaspberryMatic项目中HmIP-BWTH温控器假期模式设置问题分析 Lets-Plot 库中条形图标签在坐标轴反转时的定位问题解析 BedrockConnect项目版本兼容性问题解析与解决方案 LiquidJS 10.21.0版本新增数组过滤功能解析 Mink项目中Selenium驱动切换iframe的兼容性问题分析 Lichess移动端盲棋模式字符串优化解析 sbctl验证功能JSON输出问题解析
项目优选
收起

🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
51
15

🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
536
407

openGauss kernel ~ openGauss is an open source relational database management system
C++
63
145

React Native鸿蒙化仓库
C++
121
207

🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
400
37

本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
297
1.03 K

旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
98
252

本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
358
342

🔥🔥超过1000本的计算机经典书籍、个人笔记资料以及本人在各平台发表文章中所涉及的资源等。书籍资源包括C/C++、Java、Python、Go语言、数据结构与算法、操作系统、后端架构、计算机系统知识、数据库、计算机网络、设计模式、前端、汇编以及校招社招各种面经~
58
7

为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
51
55