commands

Documentation

Index

• Constants
• Variables
• func Cleanup()
• func Debug(format string, args ...interface{})
• func Error(format string, args ...interface{})
• func Exit(format string, args ...interface{})
• func ExitWithError(err error)
• func FullError(err error)
• func LoggedError(err error, format string, args ...interface{})
• func NewCommand(name string, runFn func(*cobra.Command, []string)) *cobra.Command
• func Panic(err error, format string, args ...interface{})
• func Print(format string, args ...interface{})
• func RegisterCommand(name string, runFn func(cmd *cobra.Command, args []string), ...)
• func Run() int
• type EntriesBySize
  • func (e EntriesBySize) Len() int
  • func (e EntriesBySize) Less(i, j int) bool
  • func (e EntriesBySize) Print(to io.Writer) (int, error)
  • func (e EntriesBySize) Swap(i, j int)
• type JSONStatus
• type JSONStatusEntry
• type MigrateInfoEntry
  • func MapToEntries(exts map[string]*MigrateInfoEntry) []*MigrateInfoEntry
• type PatternData
• type PruneProgress
• type PruneProgressChan
• type PruneProgressType

Constants

const (
	PruneProgressTypeLocal      = PruneProgressType(iota)
	PruneProgressTypeRetain     = PruneProgressType(iota)
	PruneProgressTypeVerify     = PruneProgressType(iota)
	PruneProgressTypeUnverified = PruneProgressType(iota)
)

Variables

var (
	Debugging    = false
	ErrorBuffer  = &bytes.Buffer{}
	ErrorWriter  = newMultiWriter(os.Stderr, ErrorBuffer)
	OutputWriter = newMultiWriter(os.Stdout, ErrorBuffer)
	ManPages     = make(map[string]string, 20)
)

Functions

func Cleanup

func Cleanup()

func Debug

func Debug(format string, args ...interface{})

Debug prints a formatted message if debugging is enabled. The formatted message also shows up in the panic log, if created.

func Error

func Error(format string, args ...interface{})

Error prints a formatted message to Stderr. It also gets printed to the panic log if one is created for this command.

func Exit

func Exit(format string, args ...interface{})

Exit prints a formatted message and exits.

func ExitWithError

func ExitWithError(err error)

ExitWithError either panics with a full stack trace for fatal errors, or simply prints the error message and exits immediately.

func FullError

func FullError(err error)

FullError prints either a full stack trace for fatal errors, or just the error message.

func LoggedError

func LoggedError(err error, format string, args ...interface{})

LoggedError prints the given message formatted with its arguments (if any) to Stderr. If an empty string is passed as the "format" argument, only the standard error logging message will be printed, and the error's body will be omitted.

It also writes a stack trace for the error to a log file without exiting.

func NewCommand

func NewCommand(name string, runFn func(*cobra.Command, []string)) *cobra.Command

NewCommand creates a new 'git-lfs' sub command, given a command name and command run function.

Each command will initialize the local storage ('.git/lfs') directory when run, unless the PreRun hook is set to nil.

func Panic

func Panic(err error, format string, args ...interface{})

Panic prints a formatted message, and writes a stack trace for the error to a log file before exiting.

func Print

func Print(format string, args ...interface{})

Print prints a formatted message to Stdout. It also gets printed to the panic log if one is created for this command.

func RegisterCommand

func RegisterCommand(name string, runFn func(cmd *cobra.Command, args []string), fn func(cmd *cobra.Command))

RegisterCommand creates a direct 'git-lfs' subcommand, given a command name, a command run function, and an optional callback during the command initialization process.

The 'git-lfs' command initialization is deferred until the `commands.Run()` function is called. The fn callback is passed the output from NewCommand, and gives the caller the flexibility to customize the command by adding flags, tweaking command hooks, etc.

func Run

func Run() int

Run initializes the 'git-lfs' command and runs it with the given stdin and command line args.

It returns an exit code.

Types

type EntriesBySize

type EntriesBySize []*MigrateInfoEntry

EntriesBySize is an implementation of sort.Interface that sorts a set of `*MigrateInfoEntry`'s

func (EntriesBySize) Len

func (e EntriesBySize) Len() int

Len returns the total length of the set of `*MigrateInfoEntry`'s.

func (EntriesBySize) Less

func (e EntriesBySize) Less(i, j int) bool

Less returns the whether or not the MigrateInfoEntry given at `i` takes up less total size than the MigrateInfoEntry given at `j`.

func (EntriesBySize) Print

func (e EntriesBySize) Print(to io.Writer) (int, error)

Print formats the `*MigrateInfoEntry`'s in the set and prints them to the given io.Writer, "to", returning "n" the number of bytes written, and any error, if one occurred.

func (EntriesBySize) Swap

func (e EntriesBySize) Swap(i, j int)

Swap swaps the entries given at i, j.

type JSONStatus

type JSONStatus struct {
	Files map[string]JSONStatusEntry `json:"files"`
}

type JSONStatusEntry

type JSONStatusEntry struct {
	Status string `json:"status"`
	From   string `json:"from,omitempty"`
}

type MigrateInfoEntry

type MigrateInfoEntry struct {
	// Qualifier is the filepath's extension.
	Qualifier string
	// Separate indicates if the entry should be printed separately.
	Separate bool

	// BytesAbove is total size of all files above a given threshold.
	BytesAbove int64
	// TotalAbove is the count of all files above a given size threshold.
	TotalAbove int64
	// Total is the count of all files.
	Total int64
}

MigrateInfoEntry represents a tuple of filetype to bytes and entry count above and below a threshold.

func MapToEntries

func MapToEntries(exts map[string]*MigrateInfoEntry) []*MigrateInfoEntry

MapToEntries creates a set of `*MigrateInfoEntry`'s for a given map of filepath extensions to file size in bytes.

type PatternData

type PatternData struct {
	Pattern  string `json:"pattern"`
	Source   string `json:"source"`
	Lockable bool   `json:"lockable"`
	Tracked  bool   `json:"tracked"`
}

type PruneProgress

type PruneProgress struct {
	ProgressType PruneProgressType
	Count        int // Number of items done
}

Progress from a sub-task of prune

type PruneProgressChan

type PruneProgressChan chan PruneProgress

type PruneProgressType

type PruneProgressType int