Enhance commands interface

Author: valeriobelli

CHANGELOG.md

@@ -1,5 +1,11 @@
 # gh-milestone
 
+## 1.1.0
+
+### Minor Changes
+
+- Enhance the interface of commands. Strict values are now validated and better error messages are emitted.
+
 ## 1.0.0
 
 ### Major Changes

internal/cmd/cmd.go

@@ -0,0 +1,48 @@
+package cmd
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/spf13/cobra"
+	"github.com/valeriobelli/gh-milestone/internal/pkg/utils/cmdutil"
+)
+
+const version = "v1.1.0"
+
+func Execute() {
+	var rootCommand = &cobra.Command{
+		Use:           "milestone",
+		Short:         "Manage with Github Milestones",
+		Long:          "Work with Github milestones.",
+		SilenceErrors: true,
+		RunE: func(command *cobra.Command, args []string) error {
+			versionFlag, _ := command.Flags().GetBool("version")
+
+			if versionFlag {
+				fmt.Println(version)
+
+				return nil
+			}
+
+			return command.Help()
+		},
+	}
+
+	rootCommand.SetHelpFunc(cmdutil.HelpFunction)
+	rootCommand.SetUsageFunc(cmdutil.UsageFunction)
+
+	rootCommand.Flags().BoolP("version", "v", false, "Print the version of this extension")
+
+	rootCommand.AddCommand(newCreateCommand())
+	rootCommand.AddCommand(newDeleteCommand())
+	rootCommand.AddCommand(newEditCommand())
+	rootCommand.AddCommand(newListCommand())
+	rootCommand.AddCommand(newViewCommand())
+
+	if err := rootCommand.Execute(); err != nil {
+		fmt.Println(err)
+
+		os.Exit(1)
+	}
+}

internal/cmd/create.go

@@ -2,101 +2,61 @@ package cmd
 
 import (
 	"fmt"
-	"time"
 
 	"github.com/MakeNowJust/heredoc/v2"
 	"github.com/spf13/cobra"
 	"github.com/valeriobelli/gh-milestone/internal/pkg/application/create"
+	commands_create "github.com/valeriobelli/gh-milestone/internal/pkg/domain/commands/create"
 	"github.com/valeriobelli/gh-milestone/internal/pkg/domain/constants"
-	"github.com/valeriobelli/gh-milestone/internal/pkg/domain/github"
+	"github.com/valeriobelli/gh-milestone/internal/pkg/utils/cmdutil"
 )
 
-func NewCreateCommand() *cobra.Command {
-	var getDescription = func(command *cobra.Command) string {
-		description, err := command.Flags().GetString("description")
-
-		if err != nil {
-			return ""
-		}
-
-		return description
-	}
-
-	var getDueDate = func(command *cobra.Command) (*time.Time, error) {
-		dueDate, err := command.Flags().GetString("due-date")
-
-		if err != nil {
-			return nil, err
-		}
-
-		if dueDate == "" {
-			return nil, nil
-		}
-
-		parsedDate, err := github.NewDueDate(dueDate)
-
-		if err != nil {
-			return nil, err
-		}
-
-		return &parsedDate.Time, nil
-	}
-
-	var getTitle = func(command *cobra.Command) string {
-		title, err := command.Flags().GetString("title")
-
-		if err != nil {
-			return ""
-		}
-
-		return title
-	}
+func newCreateCommand() *cobra.Command {
+	dueDate := commands_create.NewDueDateFlag()
 
 	createCommand := &cobra.Command{
 		Use:   "create",
 		Short: "Create a milestone",
-		Long: heredoc.Doc(`
-			Create a mileston on Github.
-
-			Optionally, this command permits to create a Milestone interactively when flags 
-			for required fields are not defined.
-		`),
 		Example: heredoc.Doc(`
 			# create a new milestone with a title by using flags
-			$ gh milestones create --title v1.0.0
+			$ gh milestone create --title v1.0.0
 
 			# create a new milestone by using flags
-			gh milestones create --title v1.0.0 --description "# This is a description" --due-date 2022-06-01
+			gh milestone create --title v1.0.0 --description "# This is a description" --due-date 2022-06-01
 
 			# create a new milestone interactively
-			gh milestones create
+			gh milestone create
 		`),
-		Run: func(command *cobra.Command, args []string) {
-			description := getDescription(command)
-			dueDate, err := getDueDate(command)
-			title := getTitle(command)
+		Long: heredoc.Doc(`
+			Create a milestone on Github.
 
-			if err != nil {
-				fmt.Println(err.Error())
+			Optionally, this command permits to create a Milestone interactively when flags 
+			for required fields are not defined.
+		`),
+		RunE: func(command *cobra.Command, args []string) error {
+			dueDate, err := dueDate.GetValue()
 
-				return
+			if err != nil {
+				return err
 			}
 
-			create.NewCreateMilestone(create.CreateMilestoneConfig{
+			description, _ := command.Flags().GetString("description")
+			title, _ := command.Flags().GetString("title")
+
+			return create.NewCreateMilestone(create.CreateMilestoneConfig{
 				Description: description,
 				DueDate:     dueDate,
 				Title:       title,
 			}).Execute()
 		},
 	}
 
+	createCommand.SetHelpFunc(cmdutil.HelpFunction)
+	createCommand.SetUsageFunc(cmdutil.UsageFunction)
+
 	createCommand.Flags().StringP("description", "d", "", "Set the description")
-	createCommand.Flags().StringP("due-date", "u", "", fmt.Sprintf("Set the due date [%s]", constants.DateFormat))
+	createCommand.Flags().VarP(dueDate, "due-date", "u", fmt.Sprintf("Set the due date [%s]", constants.DateFormat))
 	createCommand.Flags().StringP("title", "t", "", "Set the title")
 
 	return createCommand
 }
-
-func init() {
-	rootCommand.AddCommand(NewCreateCommand())
-}

internal/cmd/delete.go

@@ -1,59 +1,61 @@
 package cmd
 
 import (
-	"errors"
 	"fmt"
 	"strconv"
 
+	"github.com/MakeNowJust/heredoc/v2"
 	"github.com/spf13/cobra"
 	"github.com/valeriobelli/gh-milestone/internal/pkg/application/delete"
+	"github.com/valeriobelli/gh-milestone/internal/pkg/utils/cmdutil"
 )
 
-func NewDeleteCommand() *cobra.Command {
+func newDeleteCommand() *cobra.Command {
 	deleteCommand := &cobra.Command{
-		Use:   "delete",
-		Short: "Delete milestone",
-		Run: func(command *cobra.Command, args []string) {
-			if len(args) == 0 {
-				command.Help()
-
-				return
+		Use: "delete",
+		Example: heredoc.Doc(`
+			# autoconfirm the deletion
+			$ gh milestone delete 42 --confirm	
+		`),
+		Long:  "Delete a milestone",
+		Short: "Delete a milestone",
+		RunE: func(command *cobra.Command, args []string) error {
+			if len(args) < 1 {
+				return command.Help()
 			}
 
-			milestoneNumber, err := strconv.Atoi(args[0])
-
-			if err != nil {
-				fmt.Println(err.Error())
-
-				return
-			}
+			milestoneId, _ := strconv.Atoi(args[0])
 
 			confirm, _ := command.Flags().GetBool("confirm")
 
-			delete.NewDeleteMilestone(delete.DeleteMilestoneConfig{
+			return delete.NewDeleteMilestone(delete.DeleteMilestoneConfig{
 				Confirm: confirm,
-			}).Execute(milestoneNumber)
+			}).Execute(milestoneId)
 		},
-		Args: func(cmd *cobra.Command, args []string) error {
+		Args: func(command *cobra.Command, args []string) error {
 			if len(args) < 1 {
 				return nil
 			}
 
-			_, err := strconv.Atoi(args[0])
+			milestoneId := args[0]
+
+			_, err := strconv.Atoi(milestoneId)
 
 			if err != nil {
-				return errors.New("A numeric identifier is needed to delete the milestone")
+				return fmt.Errorf(
+					"the value \"%s\" is not a valid numeric identifier needed to edit a Milestone",
+					milestoneId,
+				)
 			}
 
 			return nil
 		},
 	}
 
+	deleteCommand.SetHelpFunc(cmdutil.HelpFunction)
+	deleteCommand.SetUsageFunc(cmdutil.UsageFunction)
+
 	deleteCommand.Flags().BoolP("confirm", "c", false, "Confirm deletion without prompting")
 
 	return deleteCommand
 }
-
-func init() {
-	rootCommand.AddCommand(NewDeleteCommand())
-}