gomodulepath

Documentation

Overview

Package gomodulepath implements functions for the manipulation of Go module paths. Paths are typically defined as a domain name and a path containing the user and repository names, e.g. "github.com/username/reponame", but Go also allows other module names like "domain.com/name", "name", "namespace/name", or similar variants.

Index

• func ExtractAppPath(path string) string
• type Path
  • func Find(path string) (parsed Path, appPath string, err error)
  • func Parse(rawpath string) (Path, error)
  • func ParseAt(path string) (Path, error)

Functions

func ExtractAppPath

func ExtractAppPath(path string) string

ExtractAppPath extracts the app module path from a Go module path.

Types

type Path

type Path struct {
	// Path is Go module's full path.
	// e.g.: github.com/ignite/cli.
	RawPath string

	// Root is the root directory name of Go module.
	// e.g.: cli for github.com/ignite/cli.
	Root string

	// Package is the default package name for the Go module that can be used
	// to host main functionality of the module.
	// e.g.: cli for github.com/ignite/cli.
	Package string
}

Path represents a Go module's path.

func Find

func Find(path string) (parsed Path, appPath string, err error)

Find search the Go module in the current and parent paths until finding it.

func Parse

func Parse(rawpath string) (Path, error)

Parse parses rawpath into a module Path.

func ParseAt

func ParseAt(path string) (Path, error)

ParseAt parses Go module path of an app resides at path.