How infinum/arkive works
Arkive is a Gradle plugin that discovers annotated Compose previews and XML views, generates engine-specific JVM snapshot tests, records UI snapshots, and builds a browsable web catalogue. The graph follows the documented workflow and sampled processor/plugin references; several service and generator implementations are unsampled, so their internal links are omitted or marked unverified.
Main entry points: GenerateShowcaseTask.kt Showcase tasks · ArkivePlugin.kt Arkive Gradle plugin · ArkiveProcessor.kt KSP processor · EngineTestGenerator.kt Snapshot test generation
Components 20
Component discovery
- Arkive annotations
annotations/src/commonMain/kotlin/com/infinum/arkive/annotations/ArkiveComposable.kt - KSP processor
processor/src/main/java/com/infinum/arkive/processor/ArkiveProcessor.kt - Preview collectors
processor/src/main/java/com/infinum/arkive/processor/collectors/PreviewCollector.kt - Component repository
processor/src/main/java/com/infinum/arkive/processor/repository/ComponentRepository.kt - Compose variants
processor/src/main/java/com/infinum/arkive/processor/specs/ComposeVariantSpec.kt
Snapshot capture
- Snapshot test generation
testprocessor/src/main/java/com/infinum/arkive/processor/generators/EngineTestGenerator.kt - Roborazzi engine
plugin/src/main/java/com/infinum/arkive/plugin/engines/SnapshotEngineAdapter.kt - Paparazzi engine
plugin/src/main/java/com/infinum/arkive/plugin/engines/SnapshotEngineAdapter.kt - Image snapshots
plugin/src/main/java/com/infinum/arkive/plugin/services/SnapshotsGrabber.kt - UI tree capture
composeUtils/src/main/java/com/infinum/arkive/composeutils/uitree/UiTreeSession.kt - UI tree files
composeUtils/src/main/java/com/infinum/arkive/composeutils/uitree/UiTreeFiles.kt
Catalogue generation
- Component metadata
metadata/src/main/java/com/infinum/arkive/metadata/model/ComponentsMetaData.kt - Showcase generator
plugin/src/main/java/com/infinum/arkive/plugin/generators/ShowcaseGenerator.kt - Web showcase
plugin/src/main/java/com/infinum/arkive/plugin/generators/ShowcaseWebGenerator.kt - Catalogue interface
plugin/src/main/resources/web/app.js
Gradle integration
- Arkive Gradle plugin
plugin/src/main/java/com/infinum/arkive/plugin/ArkivePlugin.kt - Engine provisioning
plugin/src/main/java/com/infinum/arkive/plugin/engines/EnginePluginProvisioning.kt - Showcase tasks
plugin/src/main/java/com/infinum/arkive/plugin/tasks/GenerateShowcaseTask.kt
Other components
- App developer
- Browser user
Connections 19
- App developer → Arkive annotations: annotates UI
README.md - Arkive annotations → KSP processor: marks components
- KSP processor → Component repository: loads components
processor/src/main/java/com/infinum/arkive/processor/ArkiveProcessor.kt - Component repository → Preview collectors: collects and validates
processor/src/main/java/com/infinum/arkive/processor/repository/ComponentRepository.kt - KSP processor → Compose variants: generates variants
- Arkive Gradle plugin → Snapshot test generation: selects engine
- Snapshot test generation → Roborazzi engine: records snapshots
- Snapshot test generation → Paparazzi engine: records snapshots
- Arkive Gradle plugin → Roborazzi engine: provisions engine
plugin/src/main/java/com/infinum/arkive/plugin/ArkivePlugin.kt - Roborazzi engine → Engine provisioning: applies plugin
plugin/src/main/java/com/infinum/arkive/plugin/engines/SnapshotEngineAdapter.kt - Arkive Gradle plugin → Showcase tasks: registers tasks
plugin/src/main/java/com/infinum/arkive/plugin/ArkivePlugin.kt - Showcase tasks → Image snapshots: reads snapshots
- Showcase tasks → UI tree capture: loads UI trees
plugin/src/main/java/com/infinum/arkive/plugin/tasks/GenerateShowcaseTask.kt - UI tree capture → UI tree files: writes tree JSON
composeUtils/src/main/java/com/infinum/arkive/composeutils/uitree/UiTreeSession.kt - Showcase tasks → Component metadata: loads metadata
- Showcase tasks → Showcase generator: generates catalogue
- Showcase generator → Web showcase: builds web output
- Web showcase → Catalogue interface: includes interface
- Browser user → Catalogue interface: views catalogue
README.md