cmd

Documentation

Overview

Package cmd exposes the CLI for Unstaged.

Copyright 2019 Jose R. Gonzalez. All rights reserved. Use of this source code is governed by the MIT license that can be found in the LICENSE file.

Index

• func OpenReposAndFilter(u Repolist) (Repolist, ReposWithErrors)
• func PrintHelp()
• func Run() int
• type Repo
• type RepoFileInput
• type RepoWithErrors
• type Repolist
• type ReposWithErrors

Functions

func OpenReposAndFilter

func OpenReposAndFilter(u Repolist) (Repolist, ReposWithErrors)

OpenReposAndFilter will check that we can open a path and that it represents a git repository.

func PrintHelp

func PrintHelp()

PrintHelp returns help output.

func Run

func Run() int

Run will execute the command line interface and then return an exit code.

Types

type Repo

type Repo *string

Repo is an indirect reference to a string.

type RepoFileInput

type RepoFileInput struct {
	R Repolist `yaml:"repos"`
}

RepoFileInput is used to unmarshal the yaml structure.

type RepoWithErrors

type RepoWithErrors struct {
	// contains filtered or unexported fields
}

RepoWithErrors takes our Repo path and stores the error object encountered.

type Repolist

type Repolist []Repo

Repolist is a slice containing multiple Repo types.

type ReposWithErrors

type ReposWithErrors []RepoWithErrors

ReposWithErrors is a slice containing multiple RepoWithErrors types.