semver

Semantic version parsing and comparison (SemVer 2.0.0).

Naming convention: import the module under its bare name (import "semver"), reach members with a backslash, and call methods in camelCase: semver\someMethod.

Methods

compare

Order two semver strings: -1 when a sorts before b, 0 when they are equal, 1 when a sorts after. Use satisfies() to test a relation or a range.

Signature: semver\compare(a, b) -> int - source

Returns: int

isValid

Whether v parses as a semantic version. Use it instead of calling parse purely to see whether it raises.

Signature: semver\isValid(v) -> bool - source

Returns: bool

canonical

Canonical "vX.Y.Z" form of v, filling in missing components and discarding build metadata; errors on invalid input.

Signature: semver\canonical(v) -> string - source

Returns: string

major

The major prefix of v as a string: major("1.2.3") is "v1". This is the cache token a spell's VersionKey{upTo = "major"} produces; parse().major is the same number as an int.

Signature: semver\major(v) -> string - source

Returns: string

majorMinor

The major.minor prefix of v as a string: majorMinor("1.2.3") is "v1.2". This is the cache token a spell's VersionKey{upTo = "minor"} produces.

Signature: semver\majorMinor(v) -> string - source

Returns: string

satisfies

Whether v meets constraint, the full range syntax magus.yaml required_version uses: ">= 1.2, < 2.0", "^1.2.3", "~1.2". compare() tests one relation; this tests a range.

Signature: semver\satisfies(v, constraint) -> bool - source

Returns: bool

parse

Parse a semver string into {major, minor, patch, prerelease, metadata, original}; errors on invalid input.

Signature: semver\parse(v) -> SemverVersion - source

Returns: map[string]any

next

Candidate next versions after v: {major, minor, patch}, each "vX.Y.Z" - the result of bumping the major, minor, or patch component. Errors on invalid input.

Signature: semver\next(v) -> SemverNext - source

Returns: map[string]any