Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oliverspryn/semver
A Kotlin library for parsing and comparing version numbers which adhere to the Semantic Versioning 2.0.0 standard
https://github.com/oliverspryn/semver
android java kotlin library semantic-version semver
Last synced: about 2 months ago
JSON representation
A Kotlin library for parsing and comparing version numbers which adhere to the Semantic Versioning 2.0.0 standard
- Host: GitHub
- URL: https://github.com/oliverspryn/semver
- Owner: oliverspryn
- License: mit
- Created: 2019-05-21T15:13:27.000Z (over 5 years ago)
- Default Branch: develop
- Last Pushed: 2023-07-10T22:31:40.000Z (over 1 year ago)
- Last Synced: 2023-07-10T23:22:38.760Z (over 1 year ago)
- Topics: android, java, kotlin, library, semantic-version, semver
- Language: Kotlin
- Homepage: https://semver.org
- Size: 79.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Semver
[](https://mvnrepository.com/artifact/com.oliverspryn.library/semver)
[](https://github.com/oliverspryn/semver/actions/workflows/build.yml)
[](https://app.codacy.com/gh/oliverspryn/semver/)
[](https://codeclimate.com/github/oliverspryn/semver/maintainability)
A Kotlin library for parsing and comparing version numbers which adhere to the [Semantic Versioning 2.0.0 standard](https://semver.org). This library handles the most common semver version and pre-release version conventions. Here are a few examples of versions the library can understand:
- `0.0.1`
- `1.0.0`
- `2.1.136`
- `2.0.0-alpha`
- `2.0.0-alpha.1`
- `2.0.0-beta.12`
- `2.0.0-rc.3`
Here are a few less common applications of the standard which are not supported by the library:
- `1.0.0-0.3.7`
- `1.0.0-x.7.z.92`
- `1.0.0-alpha.beta`
## Getting Started
To import this library into your app using Gradle, follow these steps.
For reference, the current version of this library is: [](https://mvnrepository.com/artifact/com.oliverspryn.library/semver)
**build.gradle.kts**
```kotlin
repositories {
mavenCentral()
}
dependencies {
implementation("com.oliverspryn.library:semver:")
}
```
**build.gradle**
```groovy
repositories {
mavenCentral()
}
dependencies {
implementation "com.oliverspryn.library:semver:"
}
```
## Applications of this Library
There are a variety of applications for which this library may be used. This section shows some common use cases. All of these examples can be tried out in the [main.kt file](https://github.com/oliverspryn/semver/blob/develop/src/main/kotlin/com/oliverspryn/library/main.kt) of the code.
### Comparison
Perhaps the most powerful aspect of this library is the ability to use comparison operators to perform version checks:
```kotlin
Semver("1.0.0") == Semver("1.0.0") // true
Semver("1.0.0").equals("1.0.0") // true
Semver("1.0.0").equals("Something else") // false
Semver("1.0.0") != Semver("2.0.0") // true
Semver("1.0.0") < Semver("2.0.0") // true
Semver("2.0.0") <= Semver("2.0.0") // true
Semver("2.1.0") > Semver("2.0.36") // true
Semver("2.1.0") >= Semver("2.0.36") // true
Semver("2.1.0-beta") == Semver("2.1.0-beta.0") // true
Semver("2.1.0-beta.1") == Semver("2.1.0-beta.0") // false
Semver("2.1.0-beta") > Semver("2.1.0-alpha.10") // true
Semver("2.1.0-beta.1") > Semver("2.1.0-beta") // true
Semver("2.1.0-rc.11") < Semver("2.1.0") // true
```
### Components
You can also create `Semver` objects by passing in individual components of the version number:
```kotlin
val semver = Semver(1, 5, 12)
println(semver) // 1.5.12
println(semver.major) // 1
println(semver.minor) // 5
println(semver.patch) // 12
val semverPrerelease = Semver(1, 5, 13, "beta.1")
println(semverPrerelease) // 1.5.13-beta.1
println(semverPrerelease.preReleaseVersion) // beta.1
val semverString = Semver("1.5.14-alpha.10")
println(semverString) // 1.5.14-alpha.10
println(semverString.major) // 1
println(semverString.minor) // 5
println(semverString.patch) // 14
println(semverString.preReleaseVersion) // alpha.10
```
### Formatting
This library is also capable of performing some light formatting on the given input to conform it to the semver convention.
```kotlin
println(Semver("2.01.000100")) // 2.1.100
println(Semver("1.0.0-alpha.0")) // 1.0.0-alpha
println(Semver("1.0.00-ALphA.1")) // 1.0.0-alpha.1
```