chore: Clean up flag error handling with must library

gabe565 · Nov 15, 2024 · 39dced9 · 39dced9
1 parent e774400
commit 39dced9
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 43 deletions.
diff --git a/cmd/cmd.go b/cmd/cmd.go
@@ -7,6 +7,7 @@ import (
 	"gabe565.com/changelog-generator/internal/config"
 	"gabe565.com/changelog-generator/internal/git"
 	"gabe565.com/utils/cobrax"
+	"gabe565.com/utils/must"
 	"github.com/spf13/cobra"
 )
 
@@ -27,13 +28,9 @@ func New(opts ...cobrax.Option) *cobra.Command {
 	return cmd
 }
 
-func run(cmd *cobra.Command, args []string) error {
-	completionFlag, err := cmd.Flags().GetString(config.CompletionFlag)
-	if err != nil {
-		return err
-	}
-	if completionFlag != "" {
-		return completion(cmd, args)
+func run(cmd *cobra.Command, _ []string) error {
+	if shell := must.Must2(cmd.Flags().GetString(config.CompletionFlag)); shell != "" {
+		return completion(cmd, shell)
 	}
 
 	conf, err := config.Load(cmd)

diff --git a/cmd/completion.go b/cmd/completion.go
@@ -4,19 +4,13 @@ import (
 	"errors"
 	"fmt"
 
-	"gabe565.com/changelog-generator/internal/config"
 	"github.com/spf13/cobra"
 )
 
 var ErrInvalidShell = errors.New("invalid shell")
 
-func completion(cmd *cobra.Command, _ []string) error {
-	completionFlag, err := cmd.Flags().GetString(config.CompletionFlag)
-	if err != nil {
-		panic(err)
-	}
-
-	switch completionFlag {
+func completion(cmd *cobra.Command, shell string) error {
+	switch shell {
 	case "bash":
 		return cmd.Root().GenBashCompletion(cmd.OutOrStdout())
 	case "zsh":
@@ -26,6 +20,6 @@ func completion(cmd *cobra.Command, _ []string) error {
 	case "powershell":
 		return cmd.Root().GenPowerShellCompletionWithDesc(cmd.OutOrStdout())
 	default:
-		return fmt.Errorf("%w: %s", ErrInvalidShell, completionFlag)
+		return fmt.Errorf("%w: %s", ErrInvalidShell, shell)
 	}
 }
diff --git a/internal/config/flags.go b/internal/config/flags.go
@@ -1,6 +1,9 @@
 package config
 
-import "github.com/spf13/cobra"
+import (
+	"gabe565.com/utils/must"
+	"github.com/spf13/cobra"
+)
 
 const (
 	ConfigFlag     = "config"
@@ -10,23 +13,17 @@ const (
 
 func RegisterFlags(cmd *cobra.Command) {
 	cmd.Flags().String(ConfigFlag, "", `Config file (default ".changelog-generator.yaml")`)
-	if err := cmd.RegisterFlagCompletionFunc(ConfigFlag, func(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective) {
+	must.Must(cmd.RegisterFlagCompletionFunc(ConfigFlag, func(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective) {
 		return []string{"yaml"}, cobra.ShellCompDirectiveFilterFileExt
-	}); err != nil {
-		panic(err)
-	}
+	}))
 
 	cmd.Flags().String(RepoFlag, ".", `Path to the git repo root. Parent directories will be walked until .git is found.`)
-	if err := cmd.RegisterFlagCompletionFunc(RepoFlag, func(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective) {
+	must.Must(cmd.RegisterFlagCompletionFunc(RepoFlag, func(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective) {
 		return []string{}, cobra.ShellCompDirectiveFilterDirs
-	}); err != nil {
-		panic(err)
-	}
+	}))
 
 	cmd.Flags().String(CompletionFlag, "", "Output command-line completion code for the specified shell. Can be 'bash', 'zsh', 'fish', or 'powershell'.")
-	if err := cmd.RegisterFlagCompletionFunc(CompletionFlag, func(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective) {
+	must.Must(cmd.RegisterFlagCompletionFunc(CompletionFlag, func(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective) {
 		return []string{"bash", "zsh", "fish", "powershell"}, cobra.ShellCompDirectiveNoFileComp
-	}); err != nil {
-		panic(err)
-	}
+	}))
 }
diff --git a/internal/config/load.go b/internal/config/load.go
@@ -8,6 +8,7 @@ import (
 	"path/filepath"
 	"regexp"
 
+	"gabe565.com/utils/must"
 	"github.com/knadh/koanf/parsers/yaml"
 	"github.com/knadh/koanf/providers/confmap"
 	"github.com/knadh/koanf/providers/file"
@@ -27,17 +28,11 @@ func Load(cmd *cobra.Command) (*Config, error) {
 
 	// Find config file
 	cfgFiles := make([]string, 0, 4)
-	cfgFile, err := cmd.Flags().GetString(ConfigFlag)
-	if err != nil {
-		return nil, err
-	}
+	cfgFile := must.Must2(cmd.Flags().GetString(ConfigFlag))
 	if cfgFile != "" {
 		cfgFiles = append(cfgFiles, cfgFile)
 	} else {
-		repoPath, err := cmd.Flags().GetString(RepoFlag)
-		if err != nil {
-			return nil, err
-		}
+		repoPath := must.Must2(cmd.Flags().GetString(RepoFlag))
 		cfgFiles = append(cfgFiles,
 			filepath.Join(repoPath, ".changelog-generator.yaml"),
 			filepath.Join(repoPath, ".changelog-generator.yml"),
@@ -108,12 +103,13 @@ func Load(cmd *cobra.Command) (*Config, error) {
 
 	if conf.Tag.Regexp != "" {
 		conf.Tag.Regexp = "^" + conf.Tag.Regexp + "$"
+		var err error
 		if conf.Tag.re, err = regexp.Compile(conf.Tag.Regexp); err != nil {
 			return nil, err
 		}
 	}
 
-	return conf, err
+	return conf, nil
 }
 
 func isGoReleaser(path string) bool {

diff --git a/internal/git/git.go b/internal/git/git.go
@@ -6,18 +6,15 @@ import (
 	"slices"
 
 	"gabe565.com/changelog-generator/internal/config"
+	"gabe565.com/utils/must"
 	"github.com/go-git/go-git/v5"
 	"github.com/go-git/go-git/v5/plumbing"
 	"github.com/go-git/go-git/v5/plumbing/object"
 	"github.com/spf13/cobra"
 )
 
 func FindRepo(cmd *cobra.Command) (*git.Repository, error) {
-	repoPath, err := cmd.Flags().GetString(config.RepoFlag)
-	if err != nil {
-		return nil, err
-	}
-
+	repoPath := must.Must2(cmd.Flags().GetString(config.RepoFlag))
 	repo, err := git.PlainOpenWithOptions(repoPath, &git.PlainOpenOptions{DetectDotGit: true})
 	if err != nil {
 		return nil, err