gover

README

gover

A simple yet powerful library for working with any kind of versions in Go.

Documentation

Index

• Variables
• func Compare(a *Version, b *Version) int
• func FindMaxGeneric[T any](versions []T, getFunc func(x T) *Version, referenceVersion *Version, ...) T
• func Sort(versions []*Version)
• type Version
  • func FindMax(versions []*Version, referenceVersion *Version, onlyWithoutStringValues bool) *Version
  • func MustParseVersionFromRegex(versionString string, versionRegexp *regexp.Regexp) *Version
  • func ParseSimple(parts ...any) *Version
  • func ParseVersionFromRegex(versionString string, versionRegexp *regexp.Regexp) (*Version, error)
  • func (a *Version) CompareTo(b *Version) int
  • func (v *Version) CoreVersion() string
  • func (v *Version) DefinedSegmentCount() int
  • func (a *Version) Equals(b *Version) bool
  • func (a *Version) GreaterThan(b *Version) bool
  • func (a *Version) GreaterThanOrEqual(b *Version) bool
  • func (a *Version) LessThan(b *Version) bool
  • func (a *Version) LessThanOrEqual(b *Version) bool
  • func (v *Version) Major() int
  • func (v *Version) Minor() int
  • func (v *Version) Patch() int
  • func (v *Version) SegmentCount(onlyDefined bool) int
  • func (v *Version) String() string
• type VersionSegment
  • func (v *VersionSegment) IsDefined() bool
  • func (v *VersionSegment) String() string

Variables

var (
	ErrNoMatch = errors.New("failed matching")
)

var RegexpSemver *regexp.Regexp = regexp.MustCompile(`^(?P<d1>\d+)\.(?P<d2>\d+)\.(?P<d3>\d+)(?:-(?P<s4>[^+]+))?(?:\+(?P<s5>.*))?$`)

A regex that matches the semantic versioning pattern. d.d.d(-s)(+s)

var RegexpSimple *regexp.Regexp = regexp.MustCompile(`^(?P<d1>\d+)(?:\.(?P<d2>\d+))?(?:\.(?P<d3>\d+))?$`)

A simple regexp that matches one, two or three digits separated by a dot. d(.d)(.d)

Functions

func Compare

func Compare(a *Version, b *Version) int

func FindMaxGeneric

func FindMaxGeneric[T any](versions []T, getFunc func(x T) *Version, referenceVersion *Version, onlyWithoutStringValues bool) T

Gets the maximum version which complies to a given version of a list of objects that contain a version.

func Sort

func Sort(versions []*Version)

Types

type Version

type Version struct {
	// The raw string of the version.
	Raw string
	// The different segements of the version.
	Segments []VersionSegment
	// A field for custom data for the version object.
	CustomData any
}

Type that represents a version object.

var EmptyVersion *Version = &Version{}

An empty version, can be used to find the max version of a list.

func FindMax

func FindMax(versions []*Version, referenceVersion *Version, onlyWithoutStringValues bool) *Version

Gets the maximum version which complies to a given version of a list of versions.

func MustParseVersionFromRegex

func MustParseVersionFromRegex(versionString string, versionRegexp *regexp.Regexp) *Version

Parses the given version string with the regexp into the version object. Throws a panic on error.

func ParseSimple

func ParseSimple(parts ...any) *Version

Parses the given parts into a version.

func ParseVersionFromRegex

func ParseVersionFromRegex(versionString string, versionRegexp *regexp.Regexp) (*Version, error)

Parses the given version string with the regexp into the version object.

func (*Version) CompareTo

func (a *Version) CompareTo(b *Version) int

func (*Version) CoreVersion

func (v *Version) CoreVersion() string

CoreVersion Converts the version to a core SemVer string in the form major.minor.patch

func (*Version) DefinedSegmentCount

func (v *Version) DefinedSegmentCount() int

Returns the count of defined segments until an undefined one (or no more).

func (*Version) Equals

func (a *Version) Equals(b *Version) bool

func (*Version) GreaterThan

func (a *Version) GreaterThan(b *Version) bool

func (*Version) GreaterThanOrEqual

func (a *Version) GreaterThanOrEqual(b *Version) bool

func (*Version) LessThan

func (a *Version) LessThan(b *Version) bool

func (*Version) LessThanOrEqual

func (a *Version) LessThanOrEqual(b *Version) bool

func (*Version) Major

func (v *Version) Major() int

func (*Version) Minor

func (v *Version) Minor() int

func (*Version) Patch

func (v *Version) Patch() int

func (*Version) SegmentCount

func (v *Version) SegmentCount(onlyDefined bool) int

Returns the total count of the segments, either with undefined or without.

func (*Version) String

func (v *Version) String() string

Converts the version to a readable string.

type VersionSegment

type VersionSegment struct {
	Number       int
	Text         string
	IsText       bool
	IsNotDefined bool
}

A segment of the version, can either be a number or a text.

func (*VersionSegment) IsDefined

func (v *VersionSegment) IsDefined() bool

Returns a boolean if the segment has a defined value or not.

func (*VersionSegment) String

func (v *VersionSegment) String() string

Converts the version segment to a readable string.