Provide modes for search results

Author: huangsam

cmd/namigo/main.go

@@ -22,6 +22,11 @@ func main() {
 						Usage: "Max number of results to display",
 						Value: 10,
 					},
+					&cli.StringFlag{
+						Name:  "mode",
+						Usage: "Output mode: text/json",
+						Value: "text",
+					},
 				},
 				Subcommands: []*cli.Command{
 					{

cmd/namigo/sub/search.go

@@ -20,6 +20,7 @@ func SearchPackageAction(c *cli.Context) error {
 		return ErrMissingTerm
 	}
 	maxResults := c.Int("max")
+	outputMode := getOutputMode(c.String("mode"))
 
 	ptf := newSearchPortfolio()
 	ptfErrorCount := 0
@@ -73,9 +74,9 @@ func SearchPackageAction(c *cli.Context) error {
 
 	f := &searchFormatter{}
 
-	util.PrintResults(ptf.results.golang, "Golang", f.formatGo)
-	util.PrintResults(ptf.results.npm, "NPM", f.formatNPM)
-	util.PrintResults(ptf.results.pypi, "PyPI", f.formatPyPI)
+	util.PrintResults(ptf.results.golang, "Golang", f.formatGo, outputMode)
+	util.PrintResults(ptf.results.npm, "NPM", f.formatNPM, outputMode)
+	util.PrintResults(ptf.results.pypi, "PyPI", f.formatPyPI, outputMode)
 
 	return nil
 }
@@ -87,6 +88,7 @@ func SearchDNSAction(c *cli.Context) error {
 		return ErrMissingTerm
 	}
 	maxResults := c.Int("max")
+	outputMode := getOutputMode(c.String("mode"))
 
 	ptf := newSearchPortfolio()
 	ptfErrorCount := 0
@@ -118,7 +120,6 @@ func SearchDNSAction(c *cli.Context) error {
 
 	f := &searchFormatter{}
 
-	util.PrintResults(ptf.results.dns, "DNS", f.formatDNS)
-
+	util.PrintResults(ptf.results.dns, "DNS", f.formatDNS, outputMode)
 	return nil
 }

cmd/namigo/sub/search_priv.go

@@ -5,6 +5,7 @@ import (
 	"sync"
 
 	"github.com/huangsam/namigo/internal/model"
+	"github.com/huangsam/namigo/internal/util"
 )
 
 // searchFormatter formats different types of results.
@@ -90,3 +91,15 @@ func (p *searchPortfolio) wait() {
 func (p *searchPortfolio) count() int {
 	return p.c
 }
+
+// getOutputMode returns an OutputMode instance.
+func getOutputMode(mode string) util.OutputMode {
+	switch mode {
+	case "text":
+		return util.TextMode
+	case "json":
+		return util.JSONMode
+	default:
+		return util.TextMode
+	}
+}

internal/util/output.go

@@ -3,38 +3,63 @@ package util
 import (
 	"fmt"
 
+	"encoding/json"
+
 	"github.com/huangsam/namigo/internal/model"
 )
 
-func PrintResults(results any, label string, format func(any) string) {
+type OutputMode int
+
+const (
+	TextMode OutputMode = iota
+	JSONMode
+)
+
+func (o OutputMode) String() string {
+	switch o {
+	case TextMode:
+		return "PlainText"
+	case JSONMode:
+		return "JSON"
+	default:
+		return "Unknown"
+	}
+}
+
+func PrintResults(results any, label string, format func(any) string, mode OutputMode) {
 	switch res := results.(type) {
 	case []model.GoPackageResult:
 		if len(res) > 0 {
-			fmt.Printf("%d %s results found:\n", len(res), label)
-			for _, r := range res {
-				fmt.Println(format(r))
-			}
+			printResults(res, label, format, mode)
 		}
 	case []model.NPMPackageResult:
 		if len(res) > 0 {
-			fmt.Printf("%d %s results found:\n", len(res), label)
-			for _, r := range res {
-				fmt.Println(format(r))
-			}
+			printResults(res, label, format, mode)
 		}
 	case []model.PyPIPackageResult:
 		if len(res) > 0 {
-			fmt.Printf("%d %s results found:\n", len(res), label)
-			for _, r := range res {
-				fmt.Println(format(r))
-			}
+			printResults(res, label, format, mode)
 		}
 	case []model.DNSResult:
 		if len(res) > 0 {
-			fmt.Printf("%d %s results found:\n", len(res), label)
-			for _, r := range res {
-				fmt.Println(format(r))
-			}
+			printResults(res, label, format, mode)
+		}
+	}
+}
+
+func printResults[T any](results []T, label string, format func(any) string, mode OutputMode) {
+	switch mode {
+	case JSONMode:
+		jsonData, err := json.MarshalIndent(results, "", "  ")
+		if err != nil {
+			fmt.Printf("Cannot print %s for %s: %v\n", mode, label, err)
+			return
+		}
+		fmt.Printf("%s: %s\n", label, jsonData)
+	case TextMode:
+		fmt.Printf("%d %s results found:\n", len(results), label)
+		for _, r := range results {
+			fmt.Println(format(r))
 		}
 	}
 }