cli

Documentation

Index

• type CLI
  • func NewCLI(checkGit bool, clipboard bool, hook string) (*CLI, error)
  • func (c CLI) GitRoot() (string, error)
  • func (c CLI) Hook() error
  • func (c CLI) Init() error
  • func (c CLI) List() error
  • func (c CLI) ListPath() (string, error)
  • func (c CLI) Run() error
  • func (c CLI) Wget(src, dst string) error

Types

type CLI

type CLI struct {
	// CheckGit checks if a git repository exists.
	CheckGit bool
	// Clipboard doesn't commit, but copies the commit message to the clipboard.
	Clipboard bool
	// HookPath is the path to the file to write the commit message to.
	HookPath string
}

CLI represents this application itself.

func NewCLI

func NewCLI(checkGit bool, clipboard bool, hook string) (*CLI, error)

NewCLI returns a new CLI.

func (CLI) GitRoot

func (c CLI) GitRoot() (string, error)

GitRoot returns the path to the git root directory.

func (CLI) Hook

func (c CLI) Hook() error

Hook sets the commit hook.

func (CLI) Init

func (c CLI) Init() error

Init downloads the list of gmojis.

func (CLI) List

func (c CLI) List() error

List prints the list of gmojis.

func (CLI) ListPath

func (c CLI) ListPath() (string, error)

ListPath returns the path to the gitmojis.json file.

func (CLI) Run

func (c CLI) Run() error

Run runs CLI.

func (CLI) Wget

func (c CLI) Wget(src, dst string) error

Wget downloads a file from the given URL.