natcmp

README

natcmp provides natural sort comparisons for Go. suitable for use with slices.SortFunc since go1.21

$ go get go.senan.xyz/natcmp

Documentation

Index

• func Compare(a, b string) int

Functions

func Compare

func Compare(a, b string) int

Compare performs a natural comparison between two strings, a and b, suitable for use with slices.SortFunc by returning an integer comparing their natural order.

Natural sorting orders numeric substrings in ascending order and string substrings using lexicographical order. See:

• https://en.wikipedia.org/wiki/Natural_sort_order
• https://web.archive.org/web/20210803201519/http://davekoelle.com/alphanum.html

The result is 0 if a == b, -1 if a < b, and +1 if a > b.