https://github.com/sugarmanz/package-json
Simple Kotlin MPP module for serializing/deserializing a package.json
https://github.com/sugarmanz/package-json
kotlin mpp npm package-json serialization
Last synced: 24 days ago
JSON representation
Simple Kotlin MPP module for serializing/deserializing a package.json
- Host: GitHub
- URL: https://github.com/sugarmanz/package-json
- Owner: sugarmanz
- License: mit
- Created: 2021-12-11T05:33:13.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-03-05T23:36:07.000Z (about 3 years ago)
- Last Synced: 2025-02-05T22:57:40.439Z (3 months ago)
- Topics: kotlin, mpp, npm, package-json, serialization
- Language: Kotlin
- Homepage:
- Size: 124 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# package.json
Simple Kotlin MPP module declaring [NPMs `package.json`](https://docs.npmjs.com/cli/v8/configuring-npm/package-json) as a [Kotlinx Serializable](https://github.com/Kotlin/kotlinx.serialization) structure.
### Gradle Dependency
```kotlin
implementation("com.sugarmanz.npm:package-json:$version")
```
### Basic Usage
Parsing a `package.json`:
```kotlin
val myPackage: PackageJson = Json.decodeFromString("""
{
"name": "my-package",
// ...
}
""")
```
Adding a dependency:
```kotlin
myPackage.dependencies.add("name", "0.0.0")
```
Writing back to JSON:
```kotlin
Json.encodeToString(myPackage)
```