projects

package
v0.53.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 3, 2026 License: MIT Imports: 6 Imported by: 0

Documentation

Overview

Package projects maps a bare project name to a checkout directory, for `-C r3` run from elsewhere. Lookup is off unless F10_ROOTS is set: GH-20 fenced the binary as answering for the repo it runs in, never walking the filesystem for others, and a basename search over projects is that walk.

Index

Constants

View Source
const RootsEnv = "F10_ROOTS"

RootsEnv is a PATH-style list of globs expanding to checkouts, such as `~/code/github.com/*/*`.

Variables

View Source
var ErrDisabled = errors.New("finding a project by name needs " + RootsEnv +
	" set to a colon-separated list of globs (for example ~/code/github.com/*/*); a path such as -C ../r3 always works")

ErrDisabled means a name was given while name lookup is off.

Functions

func All added in v0.34.0

func All() ([]string, error)

All is every checkout under the roots, sorted, for `f10 standup --all`.

func Find added in v0.26.0

func Find(name string) (string, error)

Find is the one checkout named name under the roots; none or several are errors naming what was searched, since a guess would run a command against the wrong repo.

func IsCheckout added in v0.34.0

func IsCheckout(dir string) bool

IsCheckout reports whether dir is a git checkout. A linked worktree carries .git as a file rather than a directory, so both count.

func IsName

func IsName(value string) bool

IsName reports a -C value that is a project name rather than a path.

func Roots

func Roots() []string

Roots is the glob list, ~ expanded; empty means name lookup is off.

Types

This section is empty.

Jump to

Keyboard shortcuts

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