通过学习、设计或记录代码库,在源代码中放置面包屑导航。实时更新、多语言支持及更多功能。
你是否曾在庞大或陌生的代码库中迷失方向? 这个工具将帮助你解决这个问题。此外,它还能提升你的开发速度,并让你更深入地了解你的应用架构。
如果你喜欢这个项目,可以在 Twitter 上关注我 @bliashenko,了解我正在构建的内容。
查看此项目的新版本,现已作为独立应用发布。只需几次点击,您就能以更高效的方式探索代码库,创建交互式视觉指南,并在自己的博客上与他人分享!点击此处查看快速指南。
查看为此处运行的独立版本准备的示例。
工作原理: 你对代码库运行
codecrumbs命令,它会分析源代码并构建其可视化表示。写下一条 codecrumb 注释,代码库状态就会通过浏览器中的可视化客户端实时反映出来。查看 我在 React-Finland 的演讲 了解更多详情。
前提条件:更新/安装
NodeJS版本,需 >= 8.11.1
codecrumbs
(
yarn global add codecrumbs
)
2) 运行
codecrumbs -d project-src-dir -e project-src-dir/index.js
。根据你的项目调整参数:
-d
是 源代码目录,
-e
是 入口文件 。
3) 在浏览器中访问 http://localhost:2018 查看效果。
通过 CLI 参数运行 codecrumbs,或指定静态配置
暂无开放 Issues,或尚未同步最近议题。