tmux

Documentation

Index

• Variables
• type Config
• type Formater
  • func (f *Formater) Format(w io.Writer, st *gitstatus.Status) error

Variables

var DefaultCfg = Config{
	Symbols: symbols{
		Branch:     "⎇ ",
		Staged:     "● ",
		Conflict:   "✖ ",
		Modified:   "✚ ",
		Untracked:  "… ",
		Stashed:    "⚑ ",
		Clean:      "✔",
		Ahead:      "↑·",
		Behind:     "↓·",
		HashPrefix: ":",
	},
	Styles: styles{
		Clear:      "#[fg=default]",
		State:      "#[fg=red,bold]",
		Branch:     "#[fg=white,bold]",
		Remote:     "#[fg=cyan]",
		Divergence: "#[fg=default]",
		Staged:     "#[fg=green,bold]",
		Conflict:   "#[fg=red,bold]",
		Modified:   "#[fg=red,bold]",
		Untracked:  "#[fg=magenta,bold]",
		Stashed:    "#[fg=cyan,bold]",
		Clean:      "#[fg=green,bold]",
	},
	Layout: []string{"branch", "..", "remote-branch", "divergence", " - ", "flags"},
	Options: options{
		BranchMaxLen: 0,
		BranchTrim:   dirRight,
	},
}

DefaultCfg is the default tmux configuration.

Types

type Config

type Config struct {
	// Symbols contains the symbols printed before the Git status components.
	Symbols symbols
	// Styles contains the tmux style strings for symbols and Git status
	// components.
	Styles styles
	// Layout sets the output format of the Git status.
	Layout []string `yaml:",flow"`
	// Options contains additional configuration options.
	Options options
}

Config is the configuration of the Git status tmux formatter.

type Formater

type Formater struct {
	Config
	// contains filtered or unexported fields
}

A Formater formats git status to a tmux style string.

func (*Formater) Format

func (f *Formater) Format(w io.Writer, st *gitstatus.Status) error

Format writes st as json into w.