探索与记录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项目的新方式!
登录后查看全文
热门项目推荐
PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00- DDeepSeek-OCR暂无简介Python00
openPangu-Ultra-MoE-718B-V1.1昇腾原生的开源盘古 Ultra-MoE-718B-V1.1 语言模型Python00
HunyuanWorld-Mirror混元3D世界重建模型,支持多模态先验注入和多任务统一输出Python00
AI内容魔方AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。03
Spark-Scilit-X1-13BFLYTEK Spark Scilit-X1-13B is based on the latest generation of iFLYTEK Foundation Model, and has been trained on multiple core tasks derived from scientific literature. As a large language model tailored for academic research scenarios, it has shown excellent performance in Paper Assisted Reading, Academic Translation, English Polishing, and Review Generation, aiming to provide efficient and accurate intelligent assistance for researchers, faculty members, and students.Python00
GOT-OCR-2.0-hf阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile013
Spark-Chemistry-X1-13B科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
热门内容推荐
1 freeCodeCamp Cafe Menu项目中link元素的void特性解析2 freeCodeCamp课程中屏幕放大器知识点优化分析3 freeCodeCamp猫照片应用教程中的HTML注释测试问题分析4 freeCodeCamp课程视频测验中的Tab键导航问题解析5 freeCodeCamp论坛排行榜项目中的错误日志规范要求6 freeCodeCamp博客页面工作坊中的断言方法优化建议7 freeCodeCamp JavaScript高阶函数中的对象引用陷阱解析8 freeCodeCamp英语课程填空题提示缺失问题分析9 freeCodeCamp全栈开发课程中React实验项目的分类修正10 freeCodeCamp音乐播放器项目中的函数调用问题解析
项目优选
收起
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
246
2.44 K
deepin linux kernel
C
24
6
仓颉编译器源码及 cjdb 调试工具。
C++
116
89
React Native鸿蒙化仓库
JavaScript
216
297
仓颉编程语言测试用例。
Cangjie
34
79
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
355
1.69 K
暂无简介
Dart
545
119
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.01 K
595
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.02 K
407
Ascend Extension for PyTorch
Python
84
118