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: Update module dependency graphs #1844

Merged
merged 1 commit into from
Jan 23, 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
20 changes: 20 additions & 0 deletions build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,24 @@ 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)
}
}
}

// Configuration for CMP module dependency graph
moduleGraphAssert {
configurations += setOf("commonMainImplementation", "commonMainApi")
configurations += setOf("androidMainImplementation", "androidMainApi")
configurations += setOf("desktopMainImplementation", "desktopMainApi")
configurations += setOf("jsMainImplementation", "jsMainApi")
configurations += setOf("nativeMainImplementation", "nativeMainApi")
configurations += setOf("wasmJsMainImplementation", "wasmJsMainApi")
}
2 changes: 2 additions & 0 deletions core/analytics/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# :core:analytics module
## Dependency graph
![Dependency graph](../../docs/images/graphs-kmp/dep_graph_core_analytics.svg)
2 changes: 2 additions & 0 deletions core/common/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# :core:common module
## Dependency graph
![Dependency graph](../../docs/images/graphs-kmp/dep_graph_core_common.svg)
5 changes: 4 additions & 1 deletion core/data/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,7 @@ graph LR
:core:data --> :core:model
:core:data --> :core:network
:core:data --> :core:analytics
```
```
# :core:data module
## Dependency graph
![Dependency graph](../../docs/images/graphs-kmp/dep_graph_core_data.svg)
5 changes: 4 additions & 1 deletion core/datastore/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,7 @@ graph LR
end
:core:datastore --> :core:model
:core:datastore --> :core:common
```
```
# :core:datastore module
## Dependency graph
![Dependency graph](../../docs/images/graphs-kmp/dep_graph_core_datastore.svg)
5 changes: 4 additions & 1 deletion core/designsystem/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,7 @@ graph LR
:core:model["model"]
end
:core:designsystem --> :core:model
```
```
# :core:designsystem module
## Dependency graph
![Dependency graph](../../docs/images/graphs-kmp/dep_graph_core_designsystem.svg)
5 changes: 4 additions & 1 deletion core/domain/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,7 @@ graph LR
:core:domain --> :core:common
:core:domain --> :core:data
:core:domain --> :core:model
```
```
# :core:domain module
## Dependency graph
![Dependency graph](../../docs/images/graphs-kmp/dep_graph_core_domain.svg)
5 changes: 4 additions & 1 deletion core/model/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,7 @@ graph LR
:core:common["common"]
end
:core:model --> :core:common
```
```
# :core:model module
## Dependency graph
![Dependency graph](../../docs/images/graphs-kmp/dep_graph_core_model.svg)
5 changes: 4 additions & 1 deletion core/network/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,7 @@ graph LR
:core:network --> :core:common
:core:network --> :core:model
:core:network --> :core:datastore
```
```
# :core:network module
## Dependency graph
![Dependency graph](../../docs/images/graphs-kmp/dep_graph_core_network.svg)
5 changes: 4 additions & 1 deletion core/ui/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,7 @@ graph LR
:core:ui --> :core:designsystem
:core:ui --> :core:model
:core:ui --> :core:common
```
```
# :core:ui module
## Dependency graph
![Dependency graph](../../docs/images/graphs-kmp/dep_graph_core_ui.svg)
19 changes: 19 additions & 0 deletions docs/images/graphs-kmp/dep_graph_core_analytics.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-kmp/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-kmp/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.
49 changes: 49 additions & 0 deletions docs/images/graphs-kmp/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.
43 changes: 43 additions & 0 deletions docs/images/graphs-kmp/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.
Loading
Loading