semver/io.github.z4kn4fein.semver

Package-level declarations

Types

Inc

enum Inc : Enum<Inc>

Determines by which identifier the given Version should be incremented.

LooseVersionSerializer

object LooseVersionSerializer : KSerializer<Version>

Built-in kotlinx.serialization serializer that encodes and decodes non-strict Version as its string representation.

Version

@Serializable(with = VersionSerializer::class)

class Version : Comparable<Version>

This class describes a semantic version and related operations following the semver 2.0.0 specification. Instances of this class are immutable, which makes them thread-safe.

VersionFormatException

class VersionFormatException(message: String) : Exception

Version throws this exception when the semantic version parsing fails due to an invalid format.

VersionSerializer

object VersionSerializer : KSerializer<Version>

Built-in kotlinx.serialization serializer that encodes and decodes Version as its string representation.

Functions

inc

fun Version.inc(by: Inc, preRelease: String? = null): Version

Increases the version by its Inc.MAJOR, Inc.MINOR, Inc.PATCH, or Inc.PRE_RELEASE segment.

nextMajor

fun Version.nextMajor(preRelease: String? = null): Version

Increments the version by its MAJOR number. When the preRelease parameter is set, a pre-release version will be produced from the next MAJOR version. The value of preRelease will be the first pre-release identifier of the new version.

nextMinor

fun Version.nextMinor(preRelease: String? = null): Version

Increments the version by its MINOR number. When the preRelease parameter is set, a pre-release version will be produced from the next MINOR version. The value of preRelease will be the first pre-release identifier of the new version.

nextPatch

fun Version.nextPatch(preRelease: String? = null): Version

Increments the version by its PATCH number. When the version is pre-release, the PATCH number will not be incremented, only the pre-release identifier will be removed.

nextPreRelease

fun Version.nextPreRelease(preRelease: String? = null): Version

Increments the version by its PRE-RELEASE identifier or produces the next pre-release of a stable version. The preRelease parameter's value is used for setting the pre-release identity when the version is stable or has a different pre-release name. If the version is already pre-release and the first identifier matches with the preRelease parameter, a simple incrementation will apply.

satisfies

infix fun Version.satisfies(constraint: Constraint): Boolean

Determines whether the Version satisfies the given Constraint.

satisfiesAll

infix fun Version.satisfiesAll(constraints: Iterable<Constraint>): Boolean

Determines whether the Version satisfies each Constraint in the given collection.

satisfiesAny

infix fun Version.satisfiesAny(constraints: Iterable<Constraint>): Boolean

Determines whether the Version satisfies at least one Constraint in the given collection.

toVersion

fun String.toVersion(strict: Boolean = true): Version

Parses the string as a Version and returns the result or throws a VersionFormatException if the string is not a valid representation of a semantic version.

toVersionOrNull

fun String.toVersionOrNull(strict: Boolean = true): Version?

Parses the string as a Version and returns the result or null if the string is not a valid representation of a semantic version.

withoutSuffixes

fun Version.withoutSuffixes(): Version

Produces a copy of the Version without the PRE-RELEASE and BUILD METADATA identities.