ctxdetect package - gitlab.com/atomic-blend/gu-cli/gu/internal/ctxdetect

Details

Learn more about best practices

Documentation ¶

Overview ¶

Package ctxdetect works out what the user is looking at: a specific project, a GitLab group, or nothing in particular.

Index ¶

func ParseRemote(url string) (host, namespace, project string, ok bool)
type Mode
- func (m Mode) String() string
type Result
- func Detect(target string) Result

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ParseRemote ¶

func ParseRemote(url string) (host, namespace, project string, ok bool)

ParseRemote turns a git remote URL into its host, namespace and project. It handles https, ssh:// and scp-style (git@host:path) forms. ok is false for anything that is not a recognisable remote, such as a local path.

Types ¶

type Mode ¶

type Mode int

Mode is what the target directory turned out to be.

const (
	ModeAccount Mode = iota
	ModeRepo
	ModeGroup
)

The three launch modes.

func (Mode) String ¶

func (m Mode) String() string

String renders the mode for the UI breadcrumb.

type Result ¶

type Result struct {
	Mode  Mode
	Ref   forge.Ref
	Group string
	Host  string
}

Result is the outcome of detection.

func Detect ¶

func Detect(target string) Result

Detect classifies target:

ModeRepo — target is inside a git repo with a parseable origin.
ModeGroup — target's immediate children are GitLab repos sharing a common namespace prefix. Needs no configuration and self-heals as repos are cloned.
ModeAccount — anything else.

Source Files ¶

View all Source files

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