Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/05nelsonm/component-build-configuration
BuildConfiguration information for use in multi-module, or Kotlin Multiplatform common code
https://github.com/05nelsonm/component-build-configuration
android android-lib android-libraries android-library android-libs kotlin kotlin-android kotlin-multiplatform kotlin-multiplatform-library kotlin-multiplatform-mobile
Last synced: 2 months ago
JSON representation
BuildConfiguration information for use in multi-module, or Kotlin Multiplatform common code
- Host: GitHub
- URL: https://github.com/05nelsonm/component-build-configuration
- Owner: 05nelsonm
- License: apache-2.0
- Created: 2021-10-31T16:31:55.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-01-17T11:08:39.000Z (about 2 years ago)
- Last Synced: 2024-11-24T16:25:38.725Z (2 months ago)
- Topics: android, android-lib, android-libraries, android-library, android-libs, kotlin, kotlin-android, kotlin-multiplatform, kotlin-multiplatform-library, kotlin-multiplatform-mobile
- Language: Kotlin
- Homepage: https://kotlin-components.matthewnelson.io
- Size: 162 KB
- Stars: 2
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# component-build-configuration
[![badge-license]][url-license]
[![badge-latest-release]][url-latest-release]
[![badge-kotlin]][url-kotlin]
![badge-platform-android]
![badge-platform-jvm]
![badge-platform-js]
![badge-platform-js-node]
![badge-platform-linux]
![badge-platform-macos]
![badge-platform-ios]
![badge-platform-tvos]
![badge-platform-watchos]
![badge-platform-wasm]
![badge-platform-windows]
![badge-support-android-native]
![badge-support-apple-silicon]
![badge-support-js-ir]
![badge-support-linux-arm]
![badge-support-linux-mips]
A Kotlin Multiplatform library for utilizing `BuildConfiguration` details from common code.
### Get Started
```kotlin
// build.gradle.kts
dependencies {
implementation("io.matthewnelson.kotlin-components:build-configuration:3.0.5")
}
```
```groovy
// build.gradle
dependencies {
implementation "io.matthewnelson.kotlin-components:build-configuration:3.0.5"
}
```
### Kotlin Version Compatibility
**Note:** as of `2.0.0`, the experimental memory model for KotlinNative is enabled.
| build-configuration | kotlin |
|:-------------------:|:------:|
| 3.0.5 | 1.8.0 |
| 3.0.4 | 1.7.20 |
| 3.0.3 | 1.6.21 |
| 3.0.2 | 1.6.21 |
| 3.0.1 | 1.6.21 |
| 3.0.0 | 1.6.10 |
| 2.0.0 | 1.6.10 |
| 1 | 1.5.31 |
### Usage (Android example using Hilt dependency injection)
```kotlin
// module :app
import io.matthewnelson.component.build.configuration.BuildConfiguration
@Module
@InstallIn(SingletonComponent::class)
object AppModule {
@Provides
@Singleton
fun provideBuildConfig(): BuildConfiguration =
BuildConfiguration(
applicationId = BuildConfig.APPLICATION_ID,
versionName = BuildConfig.VERSION_NAME,
versionCode = BuildConfig.VERSION_CODE,
isDebug = BuildConfig.DEBUG,
variant = BuildConfig.BUILD_TYPE,
flavor = BuildConfig.FLAVOR,
)
@Provides
fun provideMyMultiPlatformClass(
buildConfiguration: BuildConfiguration
): MyMultiPlatformClass =
MyMultiPlatformClass(buildConfiguration)
}
// module :core (kotlin multiplatform project where class is in commonMain)
class MyMultiPlatformClass(private val config: BuildConfiguration) {
fun doSomethingWithString(string: String): String {
if (config.isDebug) {
// do this
} else {
// do that
}
}
}
```
### Git
This project utilizes git submodules. You will need to initialize them when
cloning the repository via:
```bash
$ git clone --recursive https://github.com/05nelsonm/component-build-configuration.git
```
If you've already cloned the repository, run:
```bash
$ git checkout master
$ git pull
$ git submodule update --init
```
In order to keep submodules updated when pulling the latest code, run:
```bash
$ git pull --recurse-submodules
```
[badge-latest-release]: https://img.shields.io/badge/latest--release-3.0.5-blue.svg?style=flat
[badge-license]: https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat
[badge-kotlin]: https://img.shields.io/badge/kotlin-1.8.0-blue.svg?logo=kotlin
[badge-platform-android]: http://img.shields.io/badge/-android-6EDB8D.svg?style=flat
[badge-platform-jvm]: http://img.shields.io/badge/-jvm-DB413D.svg?style=flat
[badge-platform-js]: http://img.shields.io/badge/-js-F8DB5D.svg?style=flat
[badge-platform-js-node]: https://img.shields.io/badge/-nodejs-68a063.svg?style=flat
[badge-platform-linux]: http://img.shields.io/badge/-linux-2D3F6C.svg?style=flat
[badge-platform-macos]: http://img.shields.io/badge/-macos-111111.svg?style=flat
[badge-platform-ios]: http://img.shields.io/badge/-ios-CDCDCD.svg?style=flat
[badge-platform-tvos]: http://img.shields.io/badge/-tvos-808080.svg?style=flat
[badge-platform-watchos]: http://img.shields.io/badge/-watchos-C0C0C0.svg?style=flat
[badge-platform-wasm]: https://img.shields.io/badge/-wasm-624FE8.svg?style=flat
[badge-platform-windows]: http://img.shields.io/badge/-windows-4D76CD.svg?style=flat
[badge-support-android-native]: http://img.shields.io/badge/support-[AndroidNative]-6EDB8D.svg?style=flat
[badge-support-apple-silicon]: http://img.shields.io/badge/support-[AppleSilicon]-43BBFF.svg?style=flat
[badge-support-js-ir]: https://img.shields.io/badge/support-[js--IR]-AAC4E0.svg?style=flat
[badge-support-linux-arm]: http://img.shields.io/badge/support-[LinuxArm]-2D3F6C.svg?style=flat
[badge-support-linux-mips]: http://img.shields.io/badge/support-[LinuxMIPS]-2D3F6C.svg?style=flat
[url-latest-release]: https://github.com/05nelsonm/component-build-configuration/releases/latest
[url-license]: https://www.apache.org/licenses/LICENSE-2.0.txt
[url-kotlin]: https://kotlinlang.org