Merge pull request #21 from augmentable-dev/cmds-cleanup

clean up error handling, abstract a validation, add a cmd desc phrase

Author: patrickdevivo

cmd/commands/helpers.go

@@ -0,0 +1,22 @@
+package commands
+
+import (
+	"fmt"
+	"os"
+	"path/filepath"
+)
+
+func validateDir(dir string) {
+	if dir == "" {
+		cwd, err := os.Getwd()
+		handleError(err)
+		dir = cwd
+	}
+
+	abs, err := filepath.Abs(filepath.Join(dir, ".git"))
+	handleError(err)
+
+	if _, err := os.Stat(abs); os.IsNotExist(err) {
+		handleError(fmt.Errorf("%s is not a git repository", abs))
+	}
+}

cmd/commands/root.go

@@ -13,6 +13,14 @@ var rootCmd = &cobra.Command{
 	Long:  `tickgit is a tool for helping you manage tickets and todos in your codebase, as a part of your git history`,
 }
 
+// TODO clean this up
+func handleError(err error) {
+	if err != nil {
+		fmt.Println(err)
+		os.Exit(1)
+	}
+}
+
 // Execute adds all child commands to the root command and sets flags appropriately.
 func Execute() {
 	if err := rootCmd.Execute(); err != nil {

cmd/commands/status.go

@@ -13,13 +13,6 @@ func init() {
 	rootCmd.AddCommand(statusCmd)
 }
 
-// TODO clean this up
-func handleError(err error) {
-	if err != nil {
-		panic(err)
-	}
-}
-
 var statusCmd = &cobra.Command{
 	Use:   "status",
 	Short: "Print a status report of the current directory",
@@ -35,6 +28,8 @@ var statusCmd = &cobra.Command{
 			handleError(err)
 		}
 
+		validateDir(dir)
+
 		r, err := git.PlainOpen(dir)
 		handleError(err)
 

cmd/commands/todos.go

@@ -17,7 +17,7 @@ func init() {
 var todosCmd = &cobra.Command{
 	Use:   "todos",
 	Short: "Print a report of current TODOs",
-	Long:  ``,
+	Long:  `Scans a given git repository looking for any code comments with TODOs. Displays a report of all the TODO items found.`,
 	Args:  cobra.MaximumNArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
 		cwd, err := os.Getwd()
@@ -29,6 +29,8 @@ var todosCmd = &cobra.Command{
 			handleError(err)
 		}
 
+		validateDir(dir)
+
 		r, err := git.PlainOpen(dir)
 		handleError(err)