Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Create module dependency graphs #2734

Merged
merged 1 commit into from
Jan 9, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions androidApp/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# :androidApp module
## Dependency graph
![Dependency graph](../docs/images/graphs/dep_graph_androidApp.svg)
11 changes: 11 additions & 0 deletions build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ plugins {
alias(libs.plugins.dependencyGuard) apply false
alias(libs.plugins.detekt) apply false
alias(libs.plugins.spotless) apply false
alias(libs.plugins.module.graph) apply true // Plugin for module graph generation

//Multiplatform Plugins
alias(libs.plugins.jetbrainsCompose) apply false
Expand All @@ -48,4 +49,14 @@ tasks.register("versionFile") {
val file = File(projectDir, "version.txt")

DynamicVersion.setDynamicVersion(file, project.version.toString())
}

// Task to print all the module paths in the project e.g. :core:data
// Used by module graph generator script
tasks.register("printModulePaths") {
subprojects {
if (subprojects.size == 0) {
println(this.path)
}
}
}
3 changes: 3 additions & 0 deletions core/common/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# :core:common module
## Dependency graph
![Dependency graph](../../docs/images/graphs/dep_graph_core_common.svg)
3 changes: 3 additions & 0 deletions core/data/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# :core:data module
## Dependency graph
![Dependency graph](../../docs/images/graphs/dep_graph_core_data.svg)
3 changes: 3 additions & 0 deletions core/database/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# :core:database module
## Dependency graph
![Dependency graph](../../docs/images/graphs/dep_graph_core_database.svg)
3 changes: 3 additions & 0 deletions core/datastore/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# :core:datastore module
## Dependency graph
![Dependency graph](../../docs/images/graphs/dep_graph_core_datastore.svg)
3 changes: 3 additions & 0 deletions core/designsystem/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# :core:designsystem module
## Dependency graph
![Dependency graph](../../docs/images/graphs/dep_graph_core_designsystem.svg)
3 changes: 3 additions & 0 deletions core/logs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# :core:logs module
## Dependency graph
![Dependency graph](../../docs/images/graphs/dep_graph_core_logs.svg)
3 changes: 3 additions & 0 deletions core/model/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# :core:model module
## Dependency graph
![Dependency graph](../../docs/images/graphs/dep_graph_core_model.svg)
3 changes: 3 additions & 0 deletions core/network/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# :core:network module
## Dependency graph
![Dependency graph](../../docs/images/graphs/dep_graph_core_network.svg)
3 changes: 3 additions & 0 deletions core/qrcode/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# :core:qrcode module
## Dependency graph
![Dependency graph](../../docs/images/graphs/dep_graph_core_qrcode.svg)
3 changes: 3 additions & 0 deletions core/ui/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# :core:ui module
## Dependency graph
![Dependency graph](../../docs/images/graphs/dep_graph_core_ui.svg)
1,075 changes: 1,075 additions & 0 deletions docs/images/graphs/dep_graph_androidApp.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 19 additions & 0 deletions docs/images/graphs/dep_graph_core_common.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
115 changes: 115 additions & 0 deletions docs/images/graphs/dep_graph_core_data.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 19 additions & 0 deletions docs/images/graphs/dep_graph_core_database.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
49 changes: 49 additions & 0 deletions docs/images/graphs/dep_graph_core_datastore.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 19 additions & 0 deletions docs/images/graphs/dep_graph_core_designsystem.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 19 additions & 0 deletions docs/images/graphs/dep_graph_core_logs.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
31 changes: 31 additions & 0 deletions docs/images/graphs/dep_graph_core_model.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading