projects

type Checkout ¶

type Checkout struct {
	Kind       Kind
	Branch     string
	Repository string
	Worktrees  int
}

Checkout describes the repository checked out at a project directory. Repository is the origin remote's repository name, else the main worktree's folder; Worktrees counts the repository's verified checkouts. A folder outside any repository has KindFolder and nothing else.

func Inspect(dir string) Checkout

type Directory ¶

type Directory struct {
	Name      string `json:"name"`
	Path      string `json:"path"`
	IsProject bool   `json:"isProject"`
}

Directory is a child directory listed while browsing for a project.

func Directories(roots []string, id string, excluded []string) ([]Directory, error)

type Discovery ¶

type Discovery struct {
	Projects []Project
	Warnings []files.Warning
}

Discovery is the result of Discover. Warnings hold recoverable errors below the roots.

func Discover(roots []string, maxDepth int, excluded []string) (Discovery, error)

type Kind ¶

type Kind string

Kind describes why a directory is listed as a project.

const (
	// KindFolder is a served root that is not itself a repository.
	KindFolder Kind = "folder"
	// KindRepo is a repository's main worktree or a submodule.
	KindRepo Kind = "repo"
	// KindWorktree is a linked worktree created by git worktree add.
	KindWorktree Kind = "worktree"
)

type Project ¶

type Project struct {
	ID         string `json:"id"`
	Name       string `json:"name"`
	Path       string `json:"path"`
	Kind       Kind   `json:"kind"`
	Group      string `json:"group"`
	Root       string `json:"root"`
	Branch     string `json:"branch"`
	Repository string `json:"repository"`
	Available  bool   `json:"available"`
}

Project is a directory that can be served as a workspace.

ID is the canonical absolute path; it is empty when the directory cannot be opened. Path is always the absolute path. Members of one repository with linked worktrees share Group, the Path of the group's main worktree (or of its first member when the main worktree is missing). Root is the served root the project, or its repository, lives in; empty when none. Branch is the checked-out branch, a short commit for a detached HEAD, or empty. Repository names the project's repository (see Checkout); empty for a folder.

type Root ¶

type Root struct {
	Path   string `json:"path"`
	Name   string `json:"name"`
	IsRepo bool   `json:"isRepo"`
}

Root is a served root directory.

func Roots(roots []string) []Root