推荐：Gradle Module Graph 插件 —— 项目依赖可视化神器！

推荐：Gradle Module Graph 插件 —— 项目依赖可视化神器！

项目地址:https://gitcode.com/gh_mirrors/mo/module-graph

🌟 想要快速理解你的大型Gradle项目中各模块的依赖关系吗？这款名为Gradle Module Graph Plugin的插件能够为你自动生成美丽的Mermaid图表，让复杂的依赖关系一目了然。

项目简介

Gradle Module Graph Plugin是一款轻量级的Gradle插件，它可以分析你的项目结构并创建出一个Mermaid语法的图形表示，展示出各个模块之间的相互依赖。这个可视化的图示能帮助开发者更好地理解和维护项目的架构。

技术分析

这款插件利用了Mermaid库的强大功能，它支持直接在Markdown文件中内嵌代码块，自动渲染为流程图或图表。Gradle Module Graph Plugin将这一特性应用到极致，通过自动化生成Mermaid代码，确保了图表与项目结构始终保持同步。

应用场景

• 在大型多模块Gradle项目中，清晰地展示模块间的依赖关系。
• 理解新接手项目时，快速梳理项目架构。
• 团队协作时，方便其他成员了解项目的整体设计和依赖布局。
• 文档编写时，提供直观的项目结构图表。

项目特点

• 自动化生成：只需添加插件配置，每次构建都会更新依赖图。
• Markdown兼容：生成的图示可直接在GitHub和GitLab的README中显示，无需额外处理。
• 高度定制化：可以配置是否显示完整路径，设置图表方向，甚至调整主题风格以符合个人偏好。

快速上手

在你的项目根目录的build.gradle（Groovy）或build.gradle.kts（Kotlin）文件中添加插件引用，并进行简单配置，即可开始使用：

// Groovy DSL
plugins {
    id "dev.iurysouza.modulegraph" version "0.5.0"
}

moduleGraphConfig {
    readmePath = "./README.md"
    heading = '### Dependency Diagram'
}

// Kotlin DSL
plugins {
    id("dev.iurysouza.modulegraph") version "0.5.0"
}

moduleGraphConfig {
    readmePath.set("./README.md")
    heading.set("### Dependency Diagram")
}

运行./gradlew createModuleGraph命令后，你将在README中看到新的依赖图。

示例

下面是一个插件生成的图表示例，展示了多个子模块之间的依赖关系：

%%{
  init: {
    'theme': 'neutral'
  }
}%%
...

结语

如果你正在寻找一种简单高效的方式来管理和呈现你的项目依赖，那么Gradle Module Graph Plugin无疑是一个值得尝试的工具。现在就加入它的社区，享受更加便捷的开发体验，同时也欢迎贡献你的想法和力量。

最后，别忘了，如果你觉得这个项目有用，不妨给作者买杯咖啡作为支持！让我们一起推动开源事业的发展。

---

此项目遵循MIT许可证，详情见License文件。

如果你觉得有用，请考虑支持作者Buy Me a Coffee！

module-graph A Gradle Plugin for visualizing your project's structure, powered by mermaidjs 项目地址: https://gitcode.com/gh_mirrors/mo/module-graph