How bright/kequality works
Project type and purpose
• This is an open-source Kotlin library project composed of three Gradle modules:
• kequality (core equality-checking API)
• diffutil (Android RecyclerView DiffUtil integration)
• androidBenchmark (Android instrumentation benchmarks for performance)
• Purpose: Provide reusable, declarative custom equality checks in Kotlin and simplify Android DiffUtil usage.
File structure
• Top-level modules (declared in settings.gradle.kts):
• kequality/… – core Kotlin library with Equality interfaces and implementations
• diffutil/… – Android library depending on kequality to generate DiffUtil callbacks
• androidBenchmark/… – Android project that runs performance benchmarks on device
• buildSrc/… holds shared Gradle Kotlin scripts and configurations (convention plugins)
• CI and publishing files:
• .github/workflows/build.yml – GitHub Actions pipeline for build/test/publish
• jitpack.yml – JitPack publishing config
• gradle/libs.versions.toml, gradle-wrapper – build tool versioning
README insights
• Core features: custom Equality<T>, CompositeEquality, various built-ins (ListEquality, NullableEquality, etc.)
• DiffUtil integration: DiffUtilDelegatingItemCallback, DiffItemCallbackById, DiffCallbackById
• Usage examples show clear separation: define Equality<T> then convert to Android DiffUtil callbacks
• Developer Workstation (IDE + Git client)
• GitHub Repo (source host)
• CI/CD Pipeline (GitHub Actions)
• buildSrc (Gradle scripts/plugins)
• Module: kequality (core library)
• Module: diffutil (Android integration library)
• Module: androidBenchmark (instrumentation module)
• Artifact Repositories: Maven Central, JitPack
• Consumers (Android apps, other Kotlin projects)
• Android Device / Emulator (benchmark execution)
• Developer → GitHub Repo: push PRs / commits
• GitHub Repo triggers CI: build.gradle.kts scripts via buildSrc
• CI → kequality, diffutil, androidBenchmark: compile–test–package
• CI → publish artifacts → Maven Central & JitPack
• Consumers retrieve kequality & diffutil from Maven Central or JitPack
• androidBenchmark module → Android Device for running benchmarks
• diffutil depends on kequality
• androidBenchmark depends on kequality & diffutil
c. Architectural patterns / design principles:
• Modularity: separate core API from platform-specific integration
• Convention over configuration via buildSrc Kotlin DSL scripts
• Declarative DSL for equality definitions (builder pattern)
• Single Responsibility: each module has one purpose (API, integration, benchmarking)
d. Key technologies / frameworks / libraries:
• Kotlin + Gradle Kotlin DSL
• Android SDK, RecyclerView DiffUtil
• JUnit / Android JUnit for tests & benchmarks
• GitHub Actions for CI
• Maven Central & JitPack for dependency distribution
Detail & essential elements
• Every Gradle module and its dependencies
• BuildSrc as the shared build logic provider
• CI trigger and artifact flow to repositories