prompt

package

v0.0.0-...-f9543a5 Latest Latest Go to latest Published: Oct 25, 2023 License: GPL-3.0 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/majewsky/gofu

Links

Open Source Insights

Documentation ¶

Index ¶

func Exec(args []string) int
type Directory
- func CurrentDirectory() Directory
- func NewDirectory(path string) (dir Directory)
type TerminalTitle
- func (t TerminalTitle) PrintTo(stdout io.Writer)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Exec ¶

func Exec(args []string) int

Exec executes the prettyprompt applet and returns an exit code (0 for success, >0 for error).

Types ¶

type Directory ¶

type Directory struct {
	Path                  string
	DisplayPath           string //formatted for display in prompt line
	TitlePath             string //formatted for display in TerminalTitle
	InBuildTree           bool
	InRepoTree            bool
	Repo                  *gitRepo
	NearestAccessiblePath string
}

Directory contains all data about a directory that the prompt needs.

func CurrentDirectory ¶

func CurrentDirectory() Directory

CurrentDirectory prepares a Directory struct for the current working directory.

func NewDirectory ¶

func NewDirectory(path string) (dir Directory)

NewDirectory prepares a Directory struct for the given path.

type TerminalTitle ¶

type TerminalTitle struct {
	HostName string
	Path     string
}

TerminalTitle contains all pieces that go into the terminal title.

func (TerminalTitle) PrintTo ¶

func (t TerminalTitle) PrintTo(stdout io.Writer)

PrintTo produces the VT command that sets the terminal title.

Source Files ¶

View all Source files

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