Fix lint issues from revive

huangsam · huangsam · commit bd96608dd7af · 2025-05-16T20:40:47.000-07:00
diff --git a/.golangci.yml b/.golangci.yml
@@ -5,6 +5,8 @@ linters:
   enable:
     # https://github.com/go-critic/go-critic
     - gocritic
+    # https://github.com/mgechev/revive
+    - revive
     # https://github.com/mdempsky/unconvert
     - unconvert
     # https://github.com/mvdan/unparam
diff --git a/cmd/namigo/main.go b/cmd/namigo/main.go
@@ -1,3 +1,4 @@
+// Package main is the entry point for the namigo CLI application.
 package main
 
 import (
@@ -16,15 +17,15 @@ var (
 )
 
 // checkSizeFlag checks for valid size flag.
-func checkSizeFlag(ctx *cli.Context, i int) error {
+func checkSizeFlag(_ *cli.Context, i int) error {
 	if i <= 0 {
 		return fmt.Errorf("size %d is invalid", i)
 	}
 	return nil
 }
 
 // checkLengthFlag checks for valid length flag.
-func checkLengthFlag(ctx *cli.Context, i int) error {
+func checkLengthFlag(_ *cli.Context, i int) error {
 	if i <= 0 {
 		return fmt.Errorf("length %d is invalid", i)
 	}
@@ -114,7 +115,7 @@ func main() {
 			{
 				Name:  "version",
 				Usage: "Print version information",
-				Action: func(ctx *cli.Context) error {
+				Action: func(*cli.Context) error {
 					fmt.Printf("namigo %s, commit %s, built at %s\n", version, commit, date)
 					return nil
 				},
diff --git a/cmd/namigo/sub/generate.go b/cmd/namigo/sub/generate.go
@@ -32,7 +32,7 @@ func GeneratePromptAction(c *cli.Context) error {
 	maxSize := c.Int("size")
 	maxLength := c.Int("length")
 
-	prompt, err := generate.GeneratePrompt(purpose, theme, demographics, interests, maxSize, maxLength)
+	prompt, err := generate.Prompt(purpose, theme, demographics, interests, maxSize, maxLength)
 	if err != nil {
 		return err
 	}
diff --git a/cmd/namigo/sub/search.go b/cmd/namigo/sub/search.go
@@ -14,6 +14,7 @@ import (
 	"github.com/urfave/cli/v2"
 )
 
+// ErrMissingSearchTerm is returned when the search term is missing.
 var ErrMissingSearchTerm = errors.New("missing search term")
 
 // SearchPackageAction searches for packages.
@@ -27,7 +28,7 @@ func SearchPackageAction(c *cli.Context) error {
 
 	ptf := search.NewSearchPortfolio(outputFormat)
 
-	ptf.Register(func(sp *search.SearchPortfolio) (model.SearchResult, error) {
+	ptf.Register(func() (model.SearchResult, error) {
 		key := model.GoKey
 		fmt.Printf("🔍 Search for %s results\n", key)
 		values, err := golang.SearchByScrape(searchTerm, maxSize)
@@ -41,7 +42,7 @@ func SearchPackageAction(c *cli.Context) error {
 		return model.SearchResult{Key: key, Records: records}, nil
 	})
 
-	ptf.Register(func(sp *search.SearchPortfolio) (model.SearchResult, error) {
+	ptf.Register(func() (model.SearchResult, error) {
 		key := model.NPMKey
 		fmt.Printf("🔍 Search for %s results\n", key)
 		values, err := npm.SearchByAPI(searchTerm, maxSize)
@@ -55,7 +56,7 @@ func SearchPackageAction(c *cli.Context) error {
 		return model.SearchResult{Key: key, Records: records}, nil
 	})
 
-	ptf.Register(func(sp *search.SearchPortfolio) (model.SearchResult, error) {
+	ptf.Register(func() (model.SearchResult, error) {
 		key := model.PyPIKey
 		fmt.Printf("🔍 Search for %s results\n", key)
 		values, err := pypi.SearchByAPI(searchTerm, maxSize)
@@ -88,7 +89,7 @@ func SearchDNSAction(c *cli.Context) error {
 
 	ptf := search.NewSearchPortfolio(outputFormat)
 
-	ptf.Register(func(sp *search.SearchPortfolio) (model.SearchResult, error) {
+	ptf.Register(func() (model.SearchResult, error) {
 		key := model.DNSKey
 		fmt.Printf("🔍 Search for %s results\n", key)
 		values, err := dns.SearchByProbe(searchTerm, maxSize)
@@ -121,7 +122,7 @@ func SearchEmailAction(c *cli.Context) error {
 
 	ptf := search.NewSearchPortfolio(outputFormat)
 
-	ptf.Register(func(sp *search.SearchPortfolio) (model.SearchResult, error) {
+	ptf.Register(func() (model.SearchResult, error) {
 		key := model.EmailKey
 		fmt.Printf("🔍 Search for %s results\n", key)
 		values, err := email.SearchByProbe(searchTerm, maxSize)
diff --git a/internal/model/extern/extern.go b/internal/model/extern/extern.go
@@ -0,0 +1,2 @@
+// Package extern provides external models.
+package extern
diff --git a/internal/model/model.go b/internal/model/model.go
@@ -0,0 +1,2 @@
+// Package model provides the data models for the application.
+package model
diff --git a/internal/model/search.go b/internal/model/search.go
@@ -3,19 +3,33 @@ package model
 import "net"
 
 const (
-	NoAuthor      = "No author"      // Fallback for author
-	NoDescription = "No description" // Fallback for description
+	// NoAuthor is a fallback for author
+	NoAuthor = "No author"
+
+	// NoDescription is a fallback for description
+	NoDescription = "No description"
 )
 
 // SearchKey is an enum for search keys
 type SearchKey int
 
 const (
+	// UnknownKey is a fallback for unknown search keys.
 	UnknownKey SearchKey = iota
+
+	// GoKey is a key for Go packages.
 	GoKey
+
+	// NPMKey is a key for NPM packages.
 	NPMKey
+
+	// PyPIKey is a key for PyPI packages.
 	PyPIKey
+
+	// DNSKey is a key for DNS records.
 	DNSKey
+
+	// EmailKey is a key for email records.
 	EmailKey
 )
 
@@ -36,9 +50,10 @@ func (k SearchKey) String() string {
 	}
 }
 
-// SearchRecord is an union type for all search record values
+// SearchRecord is an union type for all search record values.
 type SearchRecord interface{ record() }
 
+// GoPackage is a struct for Go package search results.
 type GoPackage struct {
 	Name        string // Package name
 	Path        string // Fully qualified package path
@@ -47,13 +62,15 @@ type GoPackage struct {
 
 func (*GoPackage) record() {}
 
+// NPMPackage is a struct for NPM package search results.
 type NPMPackage struct {
 	Name        string // Package name
 	Description string // Package description
 }
 
 func (*NPMPackage) record() {}
 
+// PyPIPackage is a struct for PyPI package search results.
 type PyPIPackage struct {
 	Name        string // Package name
 	Author      string // Package author
@@ -62,13 +79,15 @@ type PyPIPackage struct {
 
 func (*PyPIPackage) record() {}
 
+// DNSRecord is a struct for DNS search results.
 type DNSRecord struct {
 	FQDN   string   // Fully qualified domain name
 	IPList []net.IP // Associated IP addresses
 }
 
 func (*DNSRecord) record() {}
 
+// EmailRecord is a struct for email search results.
 type EmailRecord struct {
 	Addr           string // Email address
 	HasValidSyntax bool   // Email address has valid syntax
diff --git a/internal/util/goquery.go b/internal/util/goquery.go
@@ -32,6 +32,7 @@ func NewDocumentPipeline(
 	}
 }
 
+// Execute executes the pipeline and returns the document.
 func (dp *DocumentPipeline) Execute() (*goquery.Document, error) {
 	req, err := dp.requestBuilder()
 	if err != nil {
diff --git a/internal/util/util.go b/internal/util/util.go
@@ -1,3 +1,4 @@
+// Package util provides utility functions for the application.
 package util
 
 // dismiss ignores the error from a function/method
diff --git a/pkg/generate/generate.go b/pkg/generate/generate.go
@@ -27,8 +27,8 @@ type promptData struct {
 	MaxLength    int    // Maximum length of each name
 }
 
-// GeneratePrompt generates the prompt for AI chatbots.
-func GeneratePrompt(purpose, theme, demographics, interests string, size, length int) (string, error) {
+// Prompt generates the prompt for AI chatbots.
+func Prompt(purpose, theme, demographics, interests string, size, length int) (string, error) {
 	if size < 0 || length < 0 {
 		return "", ErrNegativeInput
 	}
diff --git a/pkg/generate/generate_test.go b/pkg/generate/generate_test.go
@@ -51,7 +51,7 @@ func TestGeneratePrompt(t *testing.T) {
 
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			got, err := generate.GeneratePrompt(tt.purpose, tt.theme, tt.demographics, tt.interests, tt.size, tt.length)
+			got, err := generate.Prompt(tt.purpose, tt.theme, tt.demographics, tt.interests, tt.size, tt.length)
 			if (err != nil) != tt.wantErr {
 				t.Errorf("GeneratePrompt() error = %v, wantErr %v", err, tt.wantErr)
 				return
diff --git a/pkg/search/format.go b/pkg/search/format.go
@@ -7,7 +7,10 @@ type FormatOption struct {
 }
 
 var (
+	// TextOption is the text output mode.
 	TextOption = FormatOption{Name: "PlainText", Value: "text"}
+
+	// JSONOption is the JSON output mode.
 	JSONOption = FormatOption{Name: "JSON", Value: "json"}
 )
 
diff --git a/pkg/search/golang/search.go b/pkg/search/golang/search.go
@@ -20,7 +20,7 @@ func SearchByScrape(name string, size int) ([]model.GoPackage, error) {
 	}
 
 	result := []model.GoPackage{}
-	doc.Find(".SearchSnippet").Each(func(i int, section *goquery.Selection) {
+	doc.Find(".SearchSnippet").Each(func(_ int, section *goquery.Selection) {
 		if len(result) >= size {
 			return
 		}
diff --git a/pkg/search/line.go b/pkg/search/line.go
@@ -11,8 +11,8 @@ const (
 	maxIPCount    = 3  // Maximum IP count
 )
 
-// SearchLineFunc formats search records as strings.
-type SearchLineFunc func(label string, result model.SearchRecord) string
+// LineFunc formats search records as strings.
+type LineFunc func(label string, result model.SearchRecord) string
 
 // GoLine formats Go package.
 func GoLine(label string, result model.SearchRecord) string {
diff --git a/pkg/search/portfolio.go b/pkg/search/portfolio.go
@@ -13,54 +13,57 @@ import (
 const resultDelay = 500 * time.Millisecond
 
 var (
-	ErrPorftolioEmpty   = errors.New("portfolio collection empty")
+	// ErrPorftolioEmpty is returned when the portfolio is empty.
+	ErrPorftolioEmpty = errors.New("portfolio collection empty")
+
+	// ErrPorftolioFailure is returned when the portfolio fails.
 	ErrPorftolioFailure = errors.New("portfolio collection failure")
 )
 
-// SearchResultFunc is a function that returns search results.
-type SearchResultFunc func(*SearchPortfolio) (model.SearchResult, error)
+// ResultFunc is a function that returns search results.
+type ResultFunc func() (model.SearchResult, error)
 
-// SearchPortfolio has entity helpers and task helpers.
-type SearchPortfolio struct {
+// Portfolio has entity helpers and task helpers.
+type Portfolio struct {
 	resultMap map[model.SearchKey][]model.SearchRecord
-	lineMap   map[model.SearchKey]SearchLineFunc
+	lineMap   map[model.SearchKey]LineFunc
 	option    FormatOption
-	funcs     []SearchResultFunc
+	funcs     []ResultFunc
 	errors    []error
 }
 
 // NewSearchPortfolio creates a new portfolio instance.
-func NewSearchPortfolio(format FormatOption) *SearchPortfolio {
-	return &SearchPortfolio{
+func NewSearchPortfolio(format FormatOption) *Portfolio {
+	return &Portfolio{
 		resultMap: map[model.SearchKey][]model.SearchRecord{},
-		lineMap: map[model.SearchKey]SearchLineFunc{
+		lineMap: map[model.SearchKey]LineFunc{
 			model.GoKey:    GoLine,
 			model.NPMKey:   NPMLine,
 			model.PyPIKey:  PyPILine,
 			model.DNSKey:   DNSLine,
 			model.EmailKey: EmailLine,
 		},
 		option: format,
-		funcs:  []SearchResultFunc{},
+		funcs:  []ResultFunc{},
 		errors: []error{},
 	}
 }
 
 // Register invokes a goroutine and increments internal WaitGroup counter.
-func (p *SearchPortfolio) Register(f SearchResultFunc) {
+func (p *Portfolio) Register(f ResultFunc) {
 	p.funcs = append(p.funcs, f)
 }
 
 // Run blocks the main thread until all goroutines complete.
-func (p *SearchPortfolio) Run() error {
+func (p *Portfolio) Run() error {
 	var wg sync.WaitGroup
 	var emu sync.Mutex
 	var rmu sync.Mutex
 	for _, fn := range p.funcs {
 		wg.Add(1)
 		go func() {
 			defer wg.Done()
-			if result, err := fn(p); err != nil {
+			if result, err := fn(); err != nil {
 				emu.Lock() // Critical section
 				p.errors = append(p.errors, err)
 				emu.Unlock()
@@ -83,7 +86,7 @@ func (p *SearchPortfolio) Run() error {
 }
 
 // Display prints results across all results
-func (p *SearchPortfolio) Display() {
+func (p *Portfolio) Display() {
 	fmt.Printf("🍺 Prepare %s results\n\n", p.option)
 	time.Sleep(resultDelay)
 	for key, records := range p.resultMap {

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+// Package main is the entry point for the namigo CLI application.`
`1`	`2`	`package main`
`2`	`3`
`3`	`4`	`import (`
`@@ -16,15 +17,15 @@ var (`
`16`	`17`	`)`
`17`	`18`
`18`	`19`	`// checkSizeFlag checks for valid size flag.`
`19`		`-func checkSizeFlag(ctx *cli.Context, i int) error {`
	`20`	`+func checkSizeFlag(_ *cli.Context, i int) error {`
`20`	`21`	`if i <= 0 {`
`21`	`22`	`return fmt.Errorf("size %d is invalid", i)`
`22`	`23`	`}`
`23`	`24`	`return nil`
`24`	`25`	`}`
`25`	`26`
`26`	`27`	`// checkLengthFlag checks for valid length flag.`
`27`		`-func checkLengthFlag(ctx *cli.Context, i int) error {`
	`28`	`+func checkLengthFlag(_ *cli.Context, i int) error {`
`28`	`29`	`if i <= 0 {`
`29`	`30`	`return fmt.Errorf("length %d is invalid", i)`
`30`	`31`	`}`
`@@ -114,7 +115,7 @@ func main() {`
`114`	`115`	`{`
`115`	`116`	`Name: "version",`
`116`	`117`	`Usage: "Print version information",`
`117`		`- Action: func(ctx *cli.Context) error {`
	`118`	`+ Action: func(*cli.Context) error {`
`118`	`119`	`fmt.Printf("namigo %s, commit %s, built at %s\n", version, commit, date)`
`119`	`120`	`return nil`
`120`	`121`	`},`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ func GeneratePromptAction(c *cli.Context) error {`
`32`	`32`	`maxSize := c.Int("size")`
`33`	`33`	`maxLength := c.Int("length")`
`34`	`34`
`35`		`- prompt, err := generate.GeneratePrompt(purpose, theme, demographics, interests, maxSize, maxLength)`
	`35`	`+ prompt, err := generate.Prompt(purpose, theme, demographics, interests, maxSize, maxLength)`
`36`	`36`	`if err != nil {`
`37`	`37`	`return err`
`38`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+// Package extern provides external models.`
	`2`	`+package extern`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+// Package model provides the data models for the application.`
	`2`	`+package model`
Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,7 @@ func NewDocumentPipeline(`
`32`	`32`	`}`
`33`	`33`	`}`
`34`	`34`
	`35`	`+// Execute executes the pipeline and returns the document.`
`35`	`36`	`func (dp DocumentPipeline) Execute() (goquery.Document, error) {`
`36`	`37`	`req, err := dp.requestBuilder()`
`37`	`38`	`if err != nil {`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+// Package util provides utility functions for the application.`
`1`	`2`	`package util`
`2`	`3`
`3`	`4`	`// dismiss ignores the error from a function/method`
Original file line number	Diff line number	Diff line change
`@@ -27,8 +27,8 @@ type promptData struct {`
`27`	`27`	`MaxLength int // Maximum length of each name`
`28`	`28`	`}`
`29`	`29`
`30`		`-// GeneratePrompt generates the prompt for AI chatbots.`
`31`		`-func GeneratePrompt(purpose, theme, demographics, interests string, size, length int) (string, error) {`
	`30`	`+// Prompt generates the prompt for AI chatbots.`
	`31`	`+func Prompt(purpose, theme, demographics, interests string, size, length int) (string, error) {`
`32`	`32`	`if size < 0 \|\| length < 0 {`
`33`	`33`	`return "", ErrNegativeInput`
`34`	`34`	`}`