https://github.com/Vram-Voskanyan/PrevGen
PreviewGenerator: Simplifying Data class Preview creation for Jetpack Compose previews.
https://github.com/Vram-Voskanyan/PrevGen
Last synced: 24 days ago
JSON representation
PreviewGenerator: Simplifying Data class Preview creation for Jetpack Compose previews.
- Host: GitHub
- URL: https://github.com/Vram-Voskanyan/PrevGen
- Owner: Vram-Voskanyan
- License: apache-2.0
- Created: 2024-01-17T08:00:24.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-31T06:12:48.000Z (about 1 year ago)
- Last Synced: 2024-11-07T13:37:00.216Z (6 months ago)
- Language: Kotlin
- Homepage:
- Size: 164 KB
- Stars: 60
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - Vram-Voskanyan/PrevGen - PreviewGenerator: Simplifying Data class Preview creation for Jetpack Compose previews. (Kotlin)
README
[](https://central.sonatype.com/artifact/io.github.vram-voskanyan.kmp/PreviewGenerator)
# Kotlin PreviewGenerator (PrevGen)
Kotlin PreviewGenerator is a lightweight compiler plugin writ ten with Kotlin Symbol Processing (KSP). Preview Generator creates preview instances for data classes, which can be used in Jetpack Compose view previews.
## Navigation
- [Setup](#setup)
- [Usage](#usage)
- [Examples](#examples)
- [Roadmap](#ongoing-and-future-works)
- [Feedback and contact us](#contact-author)
- [License](#license)
- [Contribute](#contributing)
- [Configurations](configuration.md)
## Setup
1. Add the KSP plugin in the main `build.gradle`:
```gradle
plugins {
// ...
id("com.google.devtools.ksp") version "1.9.21-1.0.15"
}
```
2. Add the Sonatype Maven URL:
```gradle
repositories {
// ...
mavenCentral()
}
```
3. Add KSP and the module into Gradle dependencies:
```gradle
dependencies {
implementation("io.github.vram-voskanyan.kmp:PreviewGenerator:1.0.0") // take latest from Maven central
ksp("io.github.vram-voskanyan.kmp:PreviewGenerator:1.0.0")
}
```
4. Sync the project, and you are good to go.
## Usage
1. Add a `@DataPreview` annotation to the class that needs to have a generated preview.
2. Rebuild the project. It will generate a Preview class inside `build\ksp\[BUILD_VARIANT]\ClassName.kt`.
## Examples
```kotlin
@DataPreview
data class DummyClass(val name: String, val age: Int, val loginDate: Long)
val previewValue = dummyClassPreview
// dummyClassPreview is a generated class which is: DummyClass(name = "Ryan", age = 85, loginDate = 1705600601029)
// Note: `loginDate` is a Timestamp ;)
```
## Do Not Do This
These are examples that will not work:
```kotlin
class A(items: List)
```
In this case, it will attempt to create an endless items.
```kotlin
data class B(enumItem: EnumValue)
```
Currently, enums and sealed classes are not supported. Make the type nullable in this case:
```kotlin
data class B(enumItem: EnumValue?)
```
For more configurations and setups, please refer here: [Configurations.md](configuration.md)
### Example for Jetpack Compose
[Medium Demo](https://medium.com/picsart-engineering/preview-jetpack-compose-views-in-seconds-previewgenerator-lib-59a7520085dd)
## Ongoing and Future Works
Since this project was developed only during non-office hours, not everything is covered. For example, the following types are not currently supported: Non-Data classes, Enum, Map, List (in progress).
We also have some exciting features in mind for implementation, depending on community interest:
1. **Customized Data Size:** Introduce an option to edit the generated data size for checking how the view behaves with large or small datasets. This may involve adding a parameter option to annotations.
2. **Flexible Data Generation:** Currently, the generator relies on an argument name-checker to pick values close to the parameter type. For the next step, we aim to provide an option to pass values from outside, allowing customization such as non-English values.
3. **Adding caching functionality:** Actually, the script is already fast, but there are plans to implement caching for pregenerated data. ;)
## Contact Author
- **Email:** [[email protected]](mailto:[email protected])
- **LinkedIn:** [Vram Voskanyan](https://www.linkedin.com/in/vram-voskanyan-146b6198/)
## License
[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0)
## Contributing
If you would like to contribute code you can do so through GitHub by forking the repository and sending a pull request.
When submitting code, please make every effort to follow existing conventions and style in order to keep the code as readable as possible.