Update printing

Author: dtaniwaki

cmd/run.go

@@ -69,12 +69,12 @@ var runCmd = &cobra.Command{
 		if len(args) == 1 {
 			dir = args[0]
 		}
-		diffMap, err := gitkustomizediff.Run(dir, opts)
+		res, err := gitkustomizediff.Run(dir, opts)
 		if err != nil {
 			fmt.Printf("%+v\n", err)
 		}
 
-		printDiffMap(dir, opts, diffMap)
+		printRunResult(dir, opts, res)
 
 		return nil
 	},
@@ -93,36 +93,40 @@ func init() {
 	runCmd.PersistentFlags().BoolVar(&runOpts.allowDirty, "allow-dirty", false, "allow dirty tree")
 }
 
-func printDiffMap(dirPath string, opts gitkustomizediff.RunOpts, diffMap *gitkustomizediff.DiffMap) {
-	dirs := diffMap.Dirs()
+func printRunResult(dirPath string, opts gitkustomizediff.RunOpts, res *gitkustomizediff.RunResult) {
+	dirs := res.DiffMap.Dirs()
 	fmt.Printf("# Git Kustomize Diff\n\n")
+
+	fmt.Printf("%s...%s\n\n", res.BaseCommit, res.TargetCommit)
+
+	fmt.Printf("<details><summary>Options</summary>\n\n")
 	fmt.Println("| name | value |")
 	fmt.Println("|-|-|")
 	fmt.Printf("| dir | %s |\n", dirPath)
 	fmt.Printf("| base | %s |\n", opts.Base)
 	fmt.Printf("| target | %s |\n", opts.Target)
-	fmt.Println("")
+	fmt.Printf("\n</details>\n\n")
 
-	fmt.Printf("## Target Kustomizations\n\n")
+	fmt.Printf("<details><summary>Target Kustomizations</summary>\n\n")
 	if len(dirs) > 0 {
 		fmt.Printf("```\n%s\n```\n", strings.Join(dirs, "\n"))
 	} else {
 		fmt.Println("N/A")
 	}
-	fmt.Println("")
+	fmt.Printf("\n</details>\n\n")
 
-	fmt.Printf("## Diff\n\n")
-	lines := make([]string, 0)
+	found := false
 	for _, dir := range dirs {
-		text := diffMap.Results[dir].AsMarkdown()
+		text := res.DiffMap.Results[dir].AsMarkdown()
 		if text != "" {
-			lines = append(lines, fmt.Sprintf("### %s:\n%s", dir, text))
+			fmt.Printf("## %s\n\n", dir)
+			fmt.Printf("<details><summary>diff</summary>\n\n")
+			fmt.Println(text)
+			fmt.Printf("\n</details>\n\n")
+			found = true
 		}
 	}
-	if len(lines) > 0 {
-		fmt.Println(strings.Join(lines, "\n"))
-	} else {
+	if !found {
 		fmt.Println("N/A")
 	}
-	fmt.Println("")
 }

pkg/gitkustomizediff/run.go

@@ -37,7 +37,13 @@ type RunOpts struct {
 	AllowDirty    bool
 }
 
-func Run(dirPath string, opts RunOpts) (*DiffMap, error) {
+type RunResult struct {
+	BaseCommit   string
+	TargetCommit string
+	DiffMap      *DiffMap
+}
+
+func Run(dirPath string, opts RunOpts) (*RunResult, error) {
 	log.Info("Start run")
 	currentGitDir := utils.NewGitDir(dirPath, opts.GitPath)
 	baseCommitish := opts.Base
@@ -121,5 +127,9 @@ func Run(dirPath string, opts RunOpts) (*DiffMap, error) {
 		return nil, err
 	}
 
-	return diffMap, nil
+	return &RunResult{
+		BaseCommit:   baseCommit,
+		TargetCommit: targetCommit,
+		DiffMap:      diffMap,
+	}, nil
 }

pkg/gitkustomizediff/run_test.go

@@ -51,13 +51,15 @@ func TestRun(t *testing.T) {
 	if !assert.NoError(t, err) {
 		t.FailNow()
 	}
-	diffMap, err := Run(tmpGitDir, RunOpts{
+	res, err := Run(tmpGitDir, RunOpts{
 		Base:   "origin/main",
 		Target: "origin/a-branch",
 	})
 	if !assert.NoError(t, err) {
 		t.FailNow()
 	}
-	assert.Equal(t, []string{"foo"}, diffMap.Dirs())
-	assert.Equal(t, expectedFooDiff, diffMap.Results["foo"].ToString())
+	assert.Equal(t, "6206e0c", res.BaseCommit)
+	assert.Equal(t, "5a1c160", res.TargetCommit)
+	assert.Equal(t, []string{"foo"}, res.DiffMap.Dirs())
+	assert.Equal(t, expectedFooDiff, res.DiffMap.Results["foo"].ToString())
 }