Added Viper

rimi-itk · rimi-itk · commit f8613f7d4c24 · 2024-06-03T10:23:28.000+02:00
diff --git a/README.md b/README.md
@@ -25,7 +25,7 @@ gh extension install .
 
 ## Usage
 
-### `changelog`
+### `gh itkdev changelog`
 
 Manage changelog based on [keep a changelog](https://keepachangelog.com/en/1.1.0/):
 
@@ -36,21 +36,43 @@ gh itkdev changelog --help
 Create changelog:
 
 ```shell
-gh itkdev changelog --create
+gh itkdev changelog create
 ```
 
-Update changelog for a pull request:
+Add pull request to changelog:
 
 ```shell
-gh itkdev changelog --fucking-changelog
+gh itkdev changelog add-pull-request
 ```
 
-Update changelog for a release (`«tag»`):
+Prepare a new release:
 
 ```shell
-gh itkdev changelog --release «tag»
+gh itkdev changelog add-release «tag»
 ```
 
+## Configuration
+
+Default option values can be set in `.gh-itkdev.yaml` in the project folder or in `$HOME`.
+
+``` yaml
+changelog:
+  «sub command»:
+    «option»: «value»
+```
+
+### Example
+
+Set the default branch for `add-release` to `main`:
+
+``` yaml
+changelog:
+  add-release:
+    base: main
+```
+
+Use `gh itkdev config` to dump the current config.
+
 ## Development
 
 ``` shell
diff --git a/changelog/add_pull_request.go b/changelog/add_pull_request.go
@@ -58,7 +58,7 @@ func addPullRequest(changelog string, pr pullRequest, itemTemplate string) (stri
 	return strings.Join(lines, "\n") + "\n", nil
 }
 
-func FuckingChangelog(name string, itemTemplate string) {
+func AddPullRequest(name string, entryTemplate string) {
 	b, err := os.ReadFile(name)
 	if err != nil {
 		log.Fatal(err)
@@ -74,7 +74,7 @@ func FuckingChangelog(name string, itemTemplate string) {
 		log.Fatalf("error getting pull request: %s\n", err)
 	}
 
-	updatedChangelog, err := addPullRequest(changelog, pr, itemTemplate)
+	updatedChangelog, err := addPullRequest(changelog, pr, entryTemplate)
 	if err != nil {
 		log.Fatalf("error adding pull request: %s\n", err)
 	}
diff --git a/changelog/add_pull_request_test.go b/changelog/add_pull_request_test.go
@@ -6,7 +6,7 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
-func TestFuckingChangelog(t *testing.T) {
+func TestAddPullRequest(t *testing.T) {
 	defaultItemTemplate := `* [PR-{{ .Number }}]({{ .Url }})
   {{ .Title }}`
 	testCases := []struct {
diff --git a/changelog/add_release.go b/changelog/add_release.go
@@ -111,7 +111,7 @@ func updateReleaseChangelog(changelog string, release string) (string, error) {
 	return strings.Join(lines, "\n") + "\n", nil
 }
 
-func Release(release string, base string, name string, commit bool) {
+func AddRelease(release string, base string, name string, commit bool) {
 	b, err := os.ReadFile(name)
 	if err != nil {
 		log.Fatal(err)
diff --git a/changelog/add_release_test.go b/changelog/add_release_test.go
@@ -8,7 +8,7 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
-func TestRelease(t *testing.T) {
+func TestAddRelease(t *testing.T) {
 	testCases := []struct {
 		changelog string
 		release   string
diff --git a/cmd/changelog.go b/cmd/changelog.go
diff --git a/cmd/changelog/add_pull_request.go b/cmd/changelog/add_pull_request.go
@@ -0,0 +1,31 @@
+/*
+Copyright © 2024 NAME HERE <EMAIL ADDRESS>
+*/
+package changelog
+
+import (
+	"github.com/rimi-itk/gh-itkdev/changelog"
+	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
+)
+
+var (
+	entryTemplate = `* [PR-{{ .Number }}]({{ .Url }})
+  {{ .Title }}`
+	addPullRequestCmd = &cobra.Command{
+		Use:   "add-pull-request",
+		Short: "Add missing pull request entry to changelog",
+		Run: func(cmd *cobra.Command, args []string) {
+			changelog.AddPullRequest(changelogName, entryTemplate)
+		},
+	}
+)
+
+func init() {
+	viperPrefix := "changelog.add-pull-request."
+	flagName := "entry-template"
+	addPullRequestCmd.Flags().StringVarP(&entryTemplate, flagName, "", entryTemplate, "pull request entry template")
+	viper.BindPFlag(viperPrefix+flagName, createCmd.Flags().Lookup(flagName))
+
+	ChangelogCmd.AddCommand(addPullRequestCmd)
+}
diff --git a/cmd/changelog/add_release.go b/cmd/changelog/add_release.go
@@ -0,0 +1,47 @@
+/*
+Copyright © 2024 NAME HERE <EMAIL ADDRESS>
+*/
+package changelog
+
+import (
+	"github.com/rimi-itk/gh-itkdev/changelog"
+	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
+)
+
+// createCmd represents the create command
+var (
+	base   = "develop"
+	commit = false
+
+	addReleaseCmd = &cobra.Command{
+		Use:   "add-release",
+		Short: "Create a release branch and update the changelog",
+		Long: `Create a release branch named release/«release» and update the changelog as per https://keepachangelog.com/en/1.1.0/
+
+Examples:
+
+gh itkdev changelog add-release 0.1.0
+gh itkdev changelog add-release v0.1.0
+`,
+		Args: cobra.ExactArgs(1),
+		Run: func(cmd *cobra.Command, args []string) {
+			release := args[0]
+
+			changelog.AddRelease(release, base, changelogName, commit)
+		},
+	}
+)
+
+func init() {
+	viperPrefix := "changelog.add-release."
+	flagName := "base"
+	addPullRequestCmd.Flags().StringVarP(&base, flagName, "", base, "base branch for release")
+	viper.BindPFlag(viperPrefix+flagName, createCmd.Flags().Lookup(flagName))
+
+	flagName = "commit"
+	addPullRequestCmd.Flags().BoolVarP(&commit, flagName, "", commit, "commit changes")
+	viper.BindPFlag(viperPrefix+flagName, createCmd.Flags().Lookup(flagName))
+
+	ChangelogCmd.AddCommand(addReleaseCmd)
+}
diff --git a/cmd/changelog/changelog.go b/cmd/changelog/changelog.go
@@ -0,0 +1,19 @@
+package changelog
+
+import (
+	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
+)
+
+var (
+	changelogName = "CHANGELOG.md"
+	ChangelogCmd  = &cobra.Command{
+		Use:   "changelog",
+		Short: "Update changelog",
+	}
+)
+
+func init() {
+	ChangelogCmd.Flags().StringVarP(&changelogName, "changelog", "", changelogName, "changelog name")
+	viper.BindPFlag("changelog.changelog", ChangelogCmd.Flags().Lookup("changelog"))
+}
diff --git a/cmd/changelog/create.go b/cmd/changelog/create.go
@@ -0,0 +1,23 @@
+/*
+Copyright © 2024 NAME HERE <EMAIL ADDRESS>
+*/
+package changelog
+
+import (
+	"github.com/rimi-itk/gh-itkdev/changelog"
+	"github.com/spf13/cobra"
+)
+
+// createCmd represents the create command
+var createCmd = &cobra.Command{
+	Use:   "create",
+	Short: "Create a changelog if it does not exist",
+	Long:  `Create a changelog if it does not exist. The changelog will used the format defined by https://keepachangelog.com/en/1.1.0/.`,
+	Run: func(cmd *cobra.Command, args []string) {
+		changelog.Create(changelogName)
+	},
+}
+
+func init() {
+	ChangelogCmd.AddCommand(createCmd)
+}
diff --git a/cmd/config.go b/cmd/config.go
@@ -0,0 +1,27 @@
+/*
+Copyright © 2024 NAME HERE <EMAIL ADDRESS>
+*/
+package cmd
+
+import (
+	"fmt"
+	"log"
+
+	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
+
+	"gopkg.in/yaml.v2"
+)
+
+var configCmd = &cobra.Command{
+	Use:   "config",
+	Short: "Show active config",
+	Run: func(cmd *cobra.Command, args []string) {
+		yaml, err := yaml.Marshal(viper.AllSettings())
+		if err != nil {
+			log.Fatal(err)
+		}
+
+		fmt.Println(string(yaml))
+	},
+}
diff --git a/cmd/root.go b/cmd/root.go
@@ -1,9 +1,11 @@
 package cmd
 
 import (
-	"os"
+	"fmt"
 
+	"github.com/rimi-itk/gh-itkdev/cmd/changelog"
 	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
 )
 
 // rootCmd represents the base command when called without any subcommands
@@ -13,22 +15,31 @@ var rootCmd = &cobra.Command{
 }
 
 // Execute adds all child commands to the root command and sets flags appropriately.
-// This is called by main.main(). It only needs to happen once to the rootCmd.
+// This is called by main.main(). It only needs to happen once to the RootCmd.
 func Execute() {
 	err := rootCmd.Execute()
-	if err != nil {
-		os.Exit(1)
-	}
+	cobra.CheckErr(err)
 }
 
 func init() {
-	// Here you will define your flags and configuration settings.
-	// Cobra supports persistent flags, which, if defined here,
-	// will be global for your application.
+	cobra.OnInitialize(initConfig)
+
+	rootCmd.AddCommand(changelog.ChangelogCmd)
+	rootCmd.AddCommand(configCmd)
+}
 
-	// rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.gh-itkdev.yaml)")
+func initConfig() {
+	viper.SetConfigName(".gh-itkdev")
+	viper.AddConfigPath(".")
+	viper.AddConfigPath("$HOME")
 
-	// Cobra also supports local flags, which will only run
-	// when this action is called directly.
-	rootCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
+	viper.AutomaticEnv()
+
+	if err := viper.ReadInConfig(); err != nil {
+		if _, ok := err.(viper.ConfigFileNotFoundError); !ok {
+			fmt.Println("Unable to read config: ", err)
+		}
+	} else {
+		fmt.Println("Using config file:", viper.ConfigFileUsed())
+	}
 }
diff --git a/go.mod b/go.mod
diff --git a/go.sum b/go.sum

Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ func addPullRequest(changelog string, pr pullRequest, itemTemplate string) (stri`
`58`	`58`	`return strings.Join(lines, "\n") + "\n", nil`
`59`	`59`	`}`
`60`	`60`
`61`		`-func FuckingChangelog(name string, itemTemplate string) {`
	`61`	`+func AddPullRequest(name string, entryTemplate string) {`
`62`	`62`	`b, err := os.ReadFile(name)`
`63`	`63`	`if err != nil {`
`64`	`64`	`log.Fatal(err)`
`@@ -74,7 +74,7 @@ func FuckingChangelog(name string, itemTemplate string) {`
`74`	`74`	`log.Fatalf("error getting pull request: %s\n", err)`
`75`	`75`	`}`
`76`	`76`
`77`		`- updatedChangelog, err := addPullRequest(changelog, pr, itemTemplate)`
	`77`	`+ updatedChangelog, err := addPullRequest(changelog, pr, entryTemplate)`
`78`	`78`	`if err != nil {`
`79`	`79`	`log.Fatalf("error adding pull request: %s\n", err)`
`80`	`80`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ import (`
`6`	`6`	`"github.com/stretchr/testify/assert"`
`7`	`7`	`)`
`8`	`8`
`9`		`-func TestFuckingChangelog(t *testing.T) {`
	`9`	`+func TestAddPullRequest(t *testing.T) {`
`10`	`10`	defaultItemTemplate := `* [PR-{{ .Number }}]({{ .Url }})
`11`	`11`	{{ .Title }}`
`12`	`12`	`testCases := []struct {`
Original file line number	Diff line number	Diff line change
`@@ -111,7 +111,7 @@ func updateReleaseChangelog(changelog string, release string) (string, error) {`
`111`	`111`	`return strings.Join(lines, "\n") + "\n", nil`
`112`	`112`	`}`
`113`	`113`
`114`		`-func Release(release string, base string, name string, commit bool) {`
	`114`	`+func AddRelease(release string, base string, name string, commit bool) {`
`115`	`115`	`b, err := os.ReadFile(name)`
`116`	`116`	`if err != nil {`
`117`	`117`	`log.Fatal(err)`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ import (`
`8`	`8`	`"github.com/stretchr/testify/assert"`
`9`	`9`	`)`
`10`	`10`
`11`		`-func TestRelease(t *testing.T) {`
	`11`	`+func TestAddRelease(t *testing.T) {`
`12`	`12`	`testCases := []struct {`
`13`	`13`	`changelog string`
`14`	`14`	`release string`