base

Documentation

Overview

Package base defines the foundational structures required to build out the dgit command suite.

Index

• Constants
• Variables
• type Command
  • func FindCommand(cmd string) *Command
  • func (c *Command) Runnable() bool

Constants

const (
	DGITENV             = "DGITENV"
	DGIT_REPO_BASE      = "DGIT_REPO_BASE"
	DGIT_PROJ_LIST_PATH = "DGIT_PROJ_LIST_PATH"
	DGIT_REMOVE_SUFFIX  = "DGIT_REMOVE_SUFFIX"
)

Environment variable keys

const KnownEnv = `
	DGITENV
	DGIT_REPO_BASE
	DGIT_PROJ_LIST_PATH
	DGIT_REMOVE_SUFFIX
	`

KnownEnv is a list of environment variables that affect the operation of the dgit command

Variables

var DGit = &Command{
	Name: "dgit",
	LongHelp: `Djmoch's Git Viewer

DGit is a template-driven alternative to CGit. It listens on a TCP
port to allow viewing Git repositories from a web browser.
`,
	Usage: "dgit <command> [arguments]",
}

Types

type Command

type Command struct {
	Run                              func(context.Context)
	Flags                            flag.FlagSet
	Name, ShortHelp, LongHelp, Usage string
	Subcommands                      []*Command
}

func FindCommand

func FindCommand(cmd string) *Command

func (*Command) Runnable

func (c *Command) Runnable() bool