Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/psuzn/multiplatform-paths
Platform specific application home and cache directories for KMP
https://github.com/psuzn/multiplatform-paths
kotlin kotlin-library kotlin-multiplatform kotlinmultiplatform
Last synced: 2 months ago
JSON representation
Platform specific application home and cache directories for KMP
- Host: GitHub
- URL: https://github.com/psuzn/multiplatform-paths
- Owner: psuzn
- License: apache-2.0
- Created: 2023-12-13T05:17:08.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-13T03:15:35.000Z (8 months ago)
- Last Synced: 2024-10-10T20:50:55.651Z (3 months ago)
- Topics: kotlin, kotlin-library, kotlin-multiplatform, kotlinmultiplatform
- Language: Kotlin
- Homepage:
- Size: 445 KB
- Stars: 27
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Multiplatform Paths
[](https://github.com/psuzn/multiplatform-paths/releases/latest)
[](https://github.com/psuzn/multiplatform-paths/actions/workflows/ci.yml)
[](http://kotlinlang.org)
> [!NOTE]
> Follow [migration guide](https://github.com/psuzn/multiplatform-paths/blob/main/migration-guides.md##v01x-to-v2x) to migrate from v0.1 to v0.2.
Platform-specific application home and cache directories for KMP.
-orange)
-limegreen?logo=nodedotjs&logoColor=white)
- [Path Mapping](#setup)
- [Setup](#setup)
- [Usage](#usage)
- [App data directory](#app-data-directory)
- [App cache directory](#app-cache-directory)
### Path Mapping
| Platform | Cache Directory | Data Directory |
|-----------------------|--------------------------------------------|--------------------------------------------|
| Android | `context.cacheDir` | `ApplicationInfo.dataDir` |
| IOS/IpadOs/WatchOs | `NSCachesDirectory` | `NSApplicationSupportDirectory` |
| Mac (native/jvm/node) | `~/Library/Caches/` | `~/Library/Application Support/` |
| Windows (jvm/node) | `C:\Users\\AppData/Caches/` | `C:\Users\\AppData/>` |
| Linux (jvm/node) | `~/.cache/` | `~/local/share/` |
### Setup
```kotlin
repositories {
mavenCentral()
}
dependencies {
implementation("me.sujanpoudel.multiplatform.utils:multiplatform-paths:0.2.2")
}
```
### Usage
#### App data directory
```kotlin
import me.sujanpoudel.utils.paths.appDataDirectory
val packageName = "example.com.app"
val dataDirectory = appDataDirectory(packageName)
```
This will return `ApplicationInfo.dataDir` on android, `NSApplicationSupportDirectory` on IOS and equivalent platform specific data
directory on other platforms.
#### App cache directory
```kotlin
import me.sujanpoudel.utils.paths.appCacheDirectory
val packageName = "example.com.app"
val dataDirectory = appCacheDirectory(packageName)
```
This will return `Context.cacheDir` on android, `NSCachesDirectory` on IOS and equivalent platform specific caches
directory on other platforms
## Other Libraries from this Repository.
- `platform-identifier` : Identify the current platform.
- `context-provider` : Get android context anywhere on your android source set.
## Table of content
- [Platform Identifier](#platform-identifier)
- [Setup](#setup-1)
- [Usage](#usage-1)
- [Get current running platform info](#get-current-running-platform-info)
- [Possible return values](#possible-return-values)
- [Context Provider](#context-provider)
- [Setup](#setup-2)
- [Usage](#usage-2)
- [Get Android Context]()
- [Contributions](#contributions)
- [License](#license)
## Platform Identifier
-orange?logo=freedesktopdoporg)
### Setup
```kotlin
repositories {
mavenCentral()
}
dependencies {
implementation("me.sujanpoudel.multiplatform.utils:platform-identifier:0.2.2")
}
```
### Usage
#### Get current running platform info
```kotlin
import me.sujanpoudel.multiplatform.utils.platformIdentifier.platform
val currentPlatform = platform()
```
#### Possible return values
It returns `Platform` sealed class:
```kotlin
sealed class Platform {
sealed class JS : Platform() {
data class Node(val os: OS, val nodeVersion: String, val v8Version: String) : JS()
data class Browser(val userAgent: String) : JS()
}
sealed class OS(open val arch: Arch) : Platform() {
data class Unknown(override val arch: Arch, val version: String) : OS(arch)
data class MacOs(override val arch: Arch, val version: String) : OS(arch)
data class IOS(override val arch: Arch, val version: String, val isSimulator: Boolean) : OS(arch)
data class WatchOs(override val arch: Arch, val version: String, val isSimulator: Boolean) : OS(arch)
data class TvOs(override val arch: Arch, val version: String, val isSimulator: Boolean) : OS(arch)
data class Android(override val arch: Arch, val buildNumber: Int, val androidVersion: String, val isWatch: Boolean, val isTv: Boolean) : OS(arch)
data class Linux(override val arch: Arch, val version: String) : OS(arch)
data class Windows(override val arch: Arch, val version: String) : OS(arch)
}
}
```
where,`Arch` is an enum representing CPU architecture
```kotlin
enum class Arch {
UNKNOWN,
X64,
X86,
ARM_X64,
ARM_X32,
}
```
## Context Provider
### Setup
```kotlin
repositories {
mavenCentral()
}
dependencies {
implementation("me.sujanpoudel.multiplatform.utils:context-provider:0.2.2")
}
```
### Usage
#### Get Android Context
```kotlin
import me.sujanpoudel.utils.contextProvider.applicationContext
import android.content.Context
val context: Context = applicationContext
```
### Contributions
Contributions are always welcome!. If you'd like to contribute, please feel free to create a PR or
open an issue.
## License
```
Copyright 2023 Sujan Poudel
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```