version_bump/semver

Semantic Versioning (SemVer 2.0.0) over the foundation Version type.

This module is pure: parsing a string into a Version, rendering it back, comparing two versions per the SemVer precedence rules (build metadata ignored, prerelease identifiers compared field-by-field), and bumping a version by a ReleaseType.

Types

ReleaseType

</>

The kind of release a set of commits warrants. Ordered Patch < Minor < Major so the “highest type wins” rule is a simple max over release_type_rank.

pub type ReleaseType {
  Patch
  Minor
  Major
}

Constructors

```
Patch
```
```
Minor
```
```
Major
```

Version

</>

A semantic version. build metadata is preserved but ignored in precedence.

pub type Version {
  Version(
    major: Int,
    minor: Int,
    patch: Int,
    prerelease: List(String),
    build: List(String),
  )
}

Constructors

Version(
  major: Int,
  minor: Int,
  patch: Int,
  prerelease: List(String),
  build: List(String),
)

VersioningMode

</>

Whether a package is in SemVer’s initial-development phase (0.y.z — spec clause 4, where the public API is not yet stable) or has a stable public API.

pub type VersioningMode {
  InitialDevelopment
  Stable
}

Constructors

```
InitialDevelopment
```
```
Stable
```

Values

bump

</>

pub fn bump(v: Version, t: ReleaseType) -> Version

Bump a version by a release type.

Clears any prerelease and build metadata. Major increments major and resets minor and patch to 0. Minor increments minor and resets patch to 0. Patch increments patch.

bump_with_prerelease

</>

pub fn bump_with_prerelease(
  v: Version,
  t: ReleaseType,
  id: String,
) -> Version

Bump a version by a release type, attaching a prerelease identifier.

The core version is bumped exactly as bump does, then a prerelease of [id, "1"] is attached, e.g. bumping 1.1.0 by Minor with "beta" yields 1.2.0-beta.1.

compare

</>

pub fn compare(a: Version, b: Version) -> order.Order

Compare two versions per SemVer 2.0.0 precedence.

Core version (major, minor, patch) is compared numerically. Build metadata is ignored. A version WITH a prerelease has LOWER precedence than the same version WITHOUT one. Prerelease identifiers are compared field-by-field: numeric identifiers compare numerically and always rank below alphanumeric ones; a longer set of identifiers wins when all preceding fields are equal.

effective_release_type

</>

pub fn effective_release_type(
  version: Version,
  t: ReleaseType,
  mode: VersioningMode,
) -> ReleaseType

The release type to actually apply, given the versioning mode. In InitialDevelopment while the major version is 0, a breaking change is downshifted to a minor bump so it stays in 0.x instead of jumping to 1.0.0; features and fixes are unaffected, and once major >= 1 the mode has no effect.

max

</>

pub fn max(versions: List(Version)) -> option.Option(Version)

The greatest version in a list per compare, or None if the list is empty.

parse

</>

pub fn parse(s: String) -> Result(Version, error.ReleaseError)

Parse a SemVer string into a Version.

Accepts an optional leading v (e.g. v1.2.3), an optional -prerelease section of dot-separated identifiers, and an optional +build metadata section of dot-separated identifiers. The order of the optional sections is core[-prerelease][+build] per the spec.

Returns a VersionError when the string is not a valid version.

release_type_rank

</>

pub fn release_type_rank(t: ReleaseType) -> Int

release_type_to_string

</>

pub fn release_type_to_string(t: ReleaseType) -> String

to_string

</>

pub fn to_string(v: Version) -> String

Render a Version back to its canonical SemVer string (no leading v).