Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/terrakok/kmp-hierarchy
Gradle Plugin to investigate KMP project's hierarchy
https://github.com/terrakok/kmp-hierarchy
gradle-plugin hmpp kmp kotlin multiplatform
Last synced: about 2 months ago
JSON representation
Gradle Plugin to investigate KMP project's hierarchy
- Host: GitHub
- URL: https://github.com/terrakok/kmp-hierarchy
- Owner: terrakok
- License: mit
- Created: 2024-04-09T13:44:43.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2024-04-12T10:30:23.000Z (8 months ago)
- Last Synced: 2024-10-24T14:28:30.511Z (about 2 months ago)
- Topics: gradle-plugin, hmpp, kmp, kotlin, multiplatform
- Language: Kotlin
- Homepage:
- Size: 59.6 KB
- Stars: 82
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
README
# KMP-hierarchy
### Gradle Plugin to investigate KMP project's hierarchy
--------------
This open-source Gradle plugin aims to help developers investigate
the HMPP structure of Kotlin Multiplatform (KMP) source sets with ease.
By graphically visualizing the relationships between source sets and clearly indicating their hierarchy,
the plugin simplifies understanding and maintaining complex KMP projects.
--------------
## Features
- Graphical visualization of dependencies between source sets
- Seamless Integration with Gradle builds
- Full compatibility with any KMP project
- Various output formats (SVG, PNG, JSON, DOT etc)
--------------
## Installation
To use KMP-hierarchy plugin, include the following in your build.gradle(.kts) file:
```kotlin
plugins {
id("io.github.terrakok.kmp-hierarchy").version("1.1")
}
```
--------------
## Usage
After successful installation, the plugin will be ready to use.
```text
./gradlew :printHierarchy
```
Example of SVG output for [compose-multiplatform/components/resources/library](https://github.com/JetBrains/compose-multiplatform/blob/master/components/resources/library/build.gradle.kts) module:
--------------
## Configuration
```kotlin
plugins {
id("org.jetbrains.kotlin.multiplatform").version("1.9.23")
id("io.github.terrakok.kmp-hierarchy").version("1.1")
}
kotlin {
//...
printHierarchy {
//Sets the formats to be used for generating output files.
formats(Format.SVG)
//Boolean variable indicating whether to include test hierarchy in the generated output.
withTestHierarchy = false
//The output directory where the generated files will be saved.
outputDir.set(layout.buildDirectory.dir("kmp-hierarchy"))
}
}
```