UX improvements, proper command usage and errors, small update v0.3.1

Author: permito

hp/cmd/list.go

@@ -11,8 +11,13 @@ var ListCmd = &cli.Command{
 	Name:        "list",
 	Aliases:     []string{"l"},
 	Usage:       "Lists currently pulled packages in workspace",
+	UsageText:   "hp list/l",
 	Description: "List all installed packages along with their identifiers. Ids correspond to order the packages have been added by and names are git repository names stripped of the author.",
 	Action: func(cCtx *cli.Context) error {
+		if cCtx.Args().Present() {
+			return hp.ErrArg
+		}
+
 		if !pkg.Initialized() {
 			return hp.ErrNotInWorkspace
 		}

hp/cmd/pull.go

@@ -6,6 +6,7 @@ import (
 	"HeaderPuller/hp/internal/ops"
 	"HeaderPuller/hp/internal/pkg"
 	"HeaderPuller/hp/internal/repo"
+	"errors"
 	"github.com/go-git/go-billy/v5/memfs"
 	"github.com/go-git/go-git/v5"
 	"github.com/go-git/go-git/v5/storage/memory"
@@ -17,16 +18,19 @@ var PullCmd = &cli.Command{
 	Aliases: []string{"p"},
 	Flags: []cli.Flag{
 		&cli.BoolFlag{
-			Name:    "ignore-extensions",
-			Aliases: []string{"i"},
-			Usage:   "ignore file extensions, allows pulling any type of file.",
+			Name:               "ignore-extensions",
+			Aliases:            []string{"i"},
+			Usage:              "ignore file extensions, allows pulling any type of file",
+			DisableDefaultText: true,
 		},
 		&cli.BoolFlag{
-			Name:    "force",
-			Aliases: []string{"f"},
-			Usage:   "force pull.",
+			Name:               "force",
+			Aliases:            []string{"f"},
+			Usage:              "force pull",
+			DisableDefaultText: true,
 		}},
-	Usage: "Pull headers in specified folder and update/create the ops file",
+	Usage:     "Pull headers in specified folder and update/create the package log file",
+	UsageText: "hp pull/p <repo-link> [file]/[from]",
 	Description: `There are 3 variations of this command:
 	- pull <repo-link> - providing the repo link will copy every valid file from <repo-link>/include/ to ./include/
 	- pull <repo-link> <file> - will copy that exact file if valid from <repo-link>/ to ./include/
@@ -35,6 +39,8 @@ var PullCmd = &cli.Command{
 	Action: func(cCtx *cli.Context) error {
 		if !cCtx.Args().Present() {
 			return hp.ErrNoArg
+		} else if cCtx.Args().Len() > 2 {
+			return errors.New("requires one or two arguments")
 		}
 
 		repoLink, headerDir := cCtx.Args().First(), cCtx.Args().Get(1)

hp/cmd/remove.go

@@ -19,9 +19,10 @@ const (
 )
 
 var RemoveCmd = &cli.Command{
-	Name:    "remove",
-	Aliases: []string{"rm", "r"},
-	Usage:   "Removes a package and updates the ops file",
+	Name:      "remove",
+	Aliases:   []string{"rm", "r"},
+	Usage:     "Removes a package and updates the package log file",
+	UsageText: "hp remove/rm/r <id>/<name>/<repo-link>",
 	Description: `Removes files and folders of all header files encompassing a package. There are 3 variations of this command:
 - remove <id> - delete by id
 - remove <name> - remove by package name
@@ -30,12 +31,12 @@ var RemoveCmd = &cli.Command{
 The ids and packages names are provided by the list command.
 `,
 	Action: func(cCtx *cli.Context) error {
-		if !pkg.Initialized() {
-			return hp.ErrNotInWorkspace
+		if cCtx.Args().Len() != 1 {
+			return hp.ErrNoArg
 		}
 
-		if !cCtx.Args().Present() {
-			return hp.ErrNoArg
+		if !pkg.Initialized() {
+			return hp.ErrNotInWorkspace
 		}
 
 		arg := cCtx.Args().First()

hp/cmd/sync.go

@@ -9,10 +9,15 @@ import (
 )
 
 var SyncCmd = &cli.Command{
-	Name:    "sync",
-	Aliases: []string{"s"},
-	Usage:   "Updates every package to the latest version.",
+	Name:      "sync",
+	Aliases:   []string{"s"},
+	Usage:     "Updates every package to the latest version",
+	UsageText: "hp sync/s",
 	Action: func(cCtx *cli.Context) error {
+		if cCtx.Args().Present() {
+			return hp.ErrArg
+		}
+
 		if !pkg.Initialized() {
 			return hp.ErrNotInWorkspace
 		}

hp/cmd/uninstall.go

@@ -1,6 +1,8 @@
 package cmd
 
 import (
+	"HeaderPuller/hp"
+	"HeaderPuller/hp/internal/ops"
 	"bufio"
 	"fmt"
 	"github.com/urfave/cli/v2"
@@ -9,25 +11,43 @@ import (
 )
 
 var UninstallCmd = &cli.Command{
-	Name:   "uninstall",
-	Usage:  "Upon confirmation, wipes hp from the computer entirely",
-	Action: Uninstall,
+	Name: "uninstall",
+	Flags: []cli.Flag{
+		&cli.BoolFlag{
+			Name:               "no-confirmation",
+			Usage:              "doesn't ask for uninstall confirmation.",
+			DisableDefaultText: true,
+		},
+	},
+	Usage:     "Upon confirmation, wipes hp from the computer entirely",
+	UsageText: "hp uninstall",
+	Action: func(cCtx *cli.Context) error {
+		if cCtx.Args().Present() {
+			return hp.ErrArg
+		}
+
+		conf := ops.New()
+		conf.SetNoConfirm(cCtx.Bool("no-confirmation"))
+
+		return Uninstall(conf)
+	},
 }
 
-var Uninstall cli.ActionFunc = func(cCtx *cli.Context) error {
-	scanner := bufio.NewScanner(os.Stdin)
-	fmt.Print("Are you sure? [Y/N] ")
-	scanner.Scan()
-	answer := scanner.Text()
-	if strings.ToUpper(answer) != "Y" {
-		return nil
+func Uninstall(c *ops.Config) error {
+	if !c.NoConfirm() {
+		scanner := bufio.NewScanner(os.Stdin)
+		fmt.Print("Are you sure? [Y/N] ")
+		scanner.Scan()
+		answer := scanner.Text()
+		if strings.ToUpper(answer) != "Y" {
+			return nil
+		}
 	}
 
 	path := fmt.Sprintf("%v/bin/hp", os.Getenv("GOPATH"))
 	err := os.Remove(path)
 	if err != nil {
 		return fmt.Errorf("%v\nhp executable must have been moved or already removed", err)
 	}
-	fmt.Println("Uninstalled successfully")
-	return nil
+	return hp.NoErrUninstalled
 }

hp/cmd/update.go

@@ -11,17 +11,22 @@ import (
 )
 
 var UpdateCmd = &cli.Command{
-	Name:    "update",
-	Aliases: []string{"u"},
-	Usage:   "Update to the latest git commit",
+	Name:      "update",
+	Aliases:   []string{"u"},
+	Usage:     "Update to the latest git commit",
+	UsageText: "hp update/u",
 	Action: func(cCtx *cli.Context) error {
+		if cCtx.Args().Present() {
+			return hp.ErrArg
+		}
+
 		executablePath, err := exec.LookPath("hp")
 		if err != nil {
 			return errors.New("hp executable not found, update unable to finish")
 		}
 
 		tmp := strconv.Itoa(time.Now().Nanosecond())
-		if err := exec.Command("git", "clone", "https://github.com/Depermitto/HeaderPuller", tmp).Run(); err != nil {
+		if err := exec.Command("git", "clone", hp.RepoLink, tmp).Run(); err != nil {
 			return errors.New("cannot clone repo, update unable to finish")
 		}
 		defer os.RemoveAll(tmp)

hp/cmd/version.go

@@ -1,15 +1,21 @@
 package cmd
 
 import (
+	"HeaderPuller/hp"
 	"fmt"
 	"github.com/urfave/cli/v2"
 )
 
 var VersionCmd = &cli.Command{
-	Name:    "version",
-	Aliases: []string{"v"},
-	Usage:   "Get program version",
+	Name:      "version",
+	Aliases:   []string{"v"},
+	Usage:     "Get program version",
+	UsageText: "hp version/v",
 	Action: func(cCtx *cli.Context) error {
+		if cCtx.Args().Present() {
+			return hp.ErrArg
+		}
+
 		fmt.Printf("hp version %v\n", cCtx.App.Version)
 		return nil
 	},

hp/cmd/wipe.go

@@ -9,17 +9,18 @@ import (
 )
 
 var WipeCmd = &cli.Command{
-	Name:  "wipe",
-	Usage: "Removes all pulled packages and the the *hp.yaml* file itself.",
+	Name:      "wipe",
+	Usage:     "Removes all pulled packages and the the *hp.yaml* file itself",
+	UsageText: "hp wipe",
 	Action: func(cCtx *cli.Context) error {
-		if !pkg.Initialized() {
-			return hp.ErrNotInWorkspace
-		}
-
 		if cCtx.Args().Present() {
 			return hp.ErrArg
 		}
 
+		if !pkg.Initialized() {
+			return hp.ErrNotInWorkspace
+		}
+
 		return Wipe()
 	},
 }

hp/hp.go

@@ -13,14 +13,15 @@ const (
 )
 
 var (
-	ErrNoArg             = errors.New("requires one argument")
+	ErrNoArg             = errors.New("no arguments provided")
+	ErrArg               = errors.New("command doesn't take any arguments")
 	ErrNoFilesFound      = errors.New("no files found")
-	ErrArg               = errors.New("this configuration doesn't take any arguments")
 	ErrNotInWorkspace    = errors.New("not in hp workspace")
 	ErrAlreadyDownloaded = errors.New("already downloaded this package")
-	NoErrPulled          = errors.New("pull successful")
-	NoErrWiped           = errors.New("wipe successful")
-	NoErrRemoved         = errors.New("removal successful")
-	NoErrSynced          = errors.New("sync successful")
-	NoErrUpdated         = errors.New("update successful")
+	NoErrPulled          = errors.New("pulled")
+	NoErrWiped           = errors.New("wiped")
+	NoErrRemoved         = errors.New("removed")
+	NoErrSynced          = errors.New("synced")
+	NoErrUpdated         = errors.New("updated")
+	NoErrUninstalled     = errors.New("uninstalled")
 )

hp/internal/ops/ops.go

@@ -3,6 +3,7 @@ package ops
 type Config struct {
 	force     bool
 	ignoreExt bool
+	noConfirm bool
 }
 
 func (c *Config) Force() bool {
@@ -21,6 +22,14 @@ func (c *Config) SetIgnoreExt(ignoreExt bool) {
 	c.ignoreExt = ignoreExt
 }
 
+func (c *Config) NoConfirm() bool {
+	return c.noConfirm
+}
+
+func (c *Config) SetNoConfirm(noConfirm bool) {
+	c.noConfirm = noConfirm
+}
+
 func New(configFuncs ...func(*Config)) *Config {
 	config := &Config{}
 	for _, c := range configFuncs {
@@ -33,6 +42,10 @@ func WithIgnoreExt(config *Config) {
 	config.ignoreExt = true
 }
 
+func WithNoConfirm(config *Config) {
+	config.noConfirm = true
+}
+
 func WithForce(config *Config) {
 	config.force = true
 }