module

package

v0.12.0 Latest Latest Go to latest Published: Feb 19, 2024 License: MIT Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/nhatthm/govanityrender

Links

Open Source Insights

Documentation ¶

Overview ¶

Package module provides functionalities for working with module path and versions.

Index ¶

Constants
Variables
func FindVersions(dir string) ([]string, error)
func PathVersion(s string) (Path, Version)
func PathWithVersion[P ~string](path P, v Version) string
func PathWithoutVersion[P ~string](path P) string
type Finder
type Path
- func (p Path) IsRoot() bool
type Version
- func NewVersion(major, minor, patch int) Version
- func NewVersionFromString(s string) Version
- func (v Version) LessThan(v2 Version) bool
- func (v Version) String() string

Constants ¶

View Source

const (
	// ErrInvalidVersion indicates that the version is invalid.
	ErrInvalidVersion = xerrors.Error("invalid version")
)

Variables ¶

View Source

var (
	// PathVersionRegExp matches a module version string.
	PathVersionRegExp = regexp.MustCompile(`^([a-zA-Z0-9]+([a-zA-Z0-9_/]+)?)?v\d+\.\d+\.\d+$`)
	// VersionRegExp matches a version string.
	VersionRegExp = regexp.MustCompile(`^v?(\d+)\.(\d+)\.(\d+)$`)
	// MajorVersionRegExp matches a major version string.
	MajorVersionRegExp = regexp.MustCompile(`^v?(\d+)$`)
)

Functions ¶

func FindVersions ¶

func FindVersions(dir string) ([]string, error)

FindVersions returns the module versions in the given path.

func PathVersion ¶

func PathVersion(s string) (Path, Version)

PathVersion returns the path and version from a module version string.

func PathWithVersion ¶ added in v0.4.0

func PathWithVersion[P ~string](path P, v Version) string

PathWithVersion returns the path with the version.

func PathWithoutVersion ¶ added in v0.4.0

func PathWithoutVersion[P ~string](path P) string

PathWithoutVersion returns the path without the version.

Types ¶

type Finder ¶

type Finder interface {
	Find(loc, ref string) (map[Path]Version, error)
}

Finder finds modules.

type Path ¶

type Path string

Path is the path to the module.

func (Path) IsRoot ¶

func (p Path) IsRoot() bool

IsRoot returns true if the path is the root path.

type Version ¶

type Version struct {
	Major int
	Minor int
	Patch int
}

Version is the version of the module.

func NewVersion ¶

func NewVersion(major, minor, patch int) Version

NewVersion returns a new version.

func NewVersionFromString ¶

func NewVersionFromString(s string) Version

NewVersionFromString returns a new version from a string.

func (Version) LessThan ¶

func (v Version) LessThan(v2 Version) bool

LessThan returns true if the left version is less than the right version.

func (Version) String ¶

func (v Version) String() string

String returns the string representation of the version.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL