Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marco-eckstein/kotlin-lib
A general-purpose multiplatform library. Implemented in Kotlin, usable also from Java, JavaScript and more.
https://github.com/marco-eckstein/kotlin-lib
java javascript jvm kotlin kotlin-multiplatform library utilities
Last synced: 3 months ago
JSON representation
A general-purpose multiplatform library. Implemented in Kotlin, usable also from Java, JavaScript and more.
- Host: GitHub
- URL: https://github.com/marco-eckstein/kotlin-lib
- Owner: marco-eckstein
- License: mit
- Created: 2021-03-03T22:59:23.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-12-29T05:04:30.000Z (about 2 years ago)
- Last Synced: 2024-10-01T19:18:30.859Z (4 months ago)
- Topics: java, javascript, jvm, kotlin, kotlin-multiplatform, library, utilities
- Language: Kotlin
- Homepage:
- Size: 188 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# kotlin-lib
[](
https://github.com/marco-eckstein/kotlin-lib/actions?query=workflow%3A"Java+CI+with+Gradle"
)
[](
https://search.maven.org/search?q=g:com.marcoeckstein%20a:kotlin-lib*
)
[](
https://javadoc.io/doc/com.marcoeckstein/kotlin-lib
)
[](
https://badge.fury.io/js/%40marco-eckstein%2Fkotlin-lib
)
[](
https://npm-stat.com/charts.html?package=%40marco-eckstein%2Fkotlin-lib&from=2022-12-20
)
A general-purpose multiplatform library. Implemented in Kotlin, usable also from Java, JavaScript/TypeScript
and more.
Note however that due to the current nature of Kotlin Multiplatform, many parts of the library are not
available from regular JavaScript/TypeScript projects.
There are [Kotlin API docs for all platforms](https://javadoc.io/doc/com.marcoeckstein/kotlin-lib).
## Usage with JVM
You can use this library with any language that runs on the Java Virtual Machine: Java, Kotlin, Scala etc.
The build artifacts have been published to the
[Maven Central Repository](https://search.maven.org/search?q=g:com.marcoeckstein%20a:kotlin-lib*).
### Maven
```xml
com.marcoeckstein
kotlin-lib-jvm
${version}
```
### Gradle (Kotlin DSL)
```kotlin
implementation("com.marcoeckstein:kotlin-lib:$version")
```
### Gradle (Groovy DSL)
```groovy
implementation 'com.marcoeckstein:kotlin-lib:$version'
```
## Usage with Kotlin Multiplatform
Use the same snippets as for a Gradle JVM project (see above).
## Usage with JavaScript/TypeScript
```bash
npm install --save @marco-eckstein/kotlin-lib@$version
```
```TypeScript
import * as kotlinLib from "@marco-eckstein/kotlin-lib";
# Kotlin multiplatform exports full namespaces:
const klib = kotlinLib.com.marcoeckstein.klib
klib.kotlin.stringify(undefined)
```
## Usage with C, Objective-C etc.
I do not actively support this, but you should be able to build native binaries of this project yourself
using Gradle.
Please see the [Kotlin Multiplatform docs](https://kotlinlang.org/docs/multiplatform.html).
## Development
### Build locally
```bash
gradlew build
```
### Publish
*These notes are primarily for myself.*
```bash
gradlew publish -PsonatypeStagingPassword=
```
This task will include these steps:
- Sign the artifacts\
A prompt will ask for the password that encrypts the GnuPG key configured in `gradle.properties`.
- Publish the JavaScript package `build\packages\js\` to [NPM](https://www.npmjs.com/)\
You need to be logged in to NPM.
- Upload the Maven artifacts (`.jar` files etc.) to the staging repository at
[OSS Repository Hosting](https://oss.sonatype.org/) that belongs to the username configured in
`gradle.properties`.
These steps need to be performed manually:
- Login to [OSS Repository Hosting](https://oss.sonatype.org/)
- Review the artifacts
- *Close* and *Release* the repository. This will publish the artifacts to the
[Maven Central Repository](https://search.maven.org/).
Docs will appear automatically at [javadoc.io](https://www.javadoc.io/).
More info at: https://central.sonatype.org/publish/