refactor: apply golangci-lint autofixes, work around false positives

scop · marckhouzam · commit 4af7b64d3198 · 2025-05-31T08:20:04.000-04:00
diff --git a/completions.go b/completions.go
@@ -375,7 +375,7 @@ func (c *Command) getCompletions(args []string) (*Command, []Completion, ShellCo
 	// Error while attempting to parse flags
 	if flagErr != nil {
 		// If error type is flagCompError and we don't want flagCompletion we should ignore the error
-		if _, ok := flagErr.(*flagCompError); !(ok && !flagCompletion) {
+		if _, ok := flagErr.(*flagCompError); !ok || flagCompletion {
 			return finalCmd, []Completion{}, ShellCompDirectiveDefault, flagErr
 		}
 	}
@@ -773,7 +773,7 @@ See each sub-command's help for details on how to use the generated script.
 		// shell completion for it (prog __complete completion '')
 		subCmd, cmdArgs, err := c.Find(args)
 		if err != nil || subCmd.Name() != compCmdName &&
-			!(subCmd.Name() == ShellCompRequestCmd && len(cmdArgs) > 1 && cmdArgs[0] == compCmdName) {
+			(subCmd.Name() != ShellCompRequestCmd || len(cmdArgs) <= 1 || cmdArgs[0] != compCmdName) {
 			// The completion command is not being called or being completed so we remove it.
 			c.RemoveCommand(completionCmd)
 			return
diff --git a/completions_test.go b/completions_test.go
@@ -2899,7 +2899,7 @@ func TestCompletionFuncCompatibility(t *testing.T) {
 			var userComp func(cmd *Command, args []string, toComplete string) ([]string, ShellCompDirective)
 
 			// check against new signature
-			var _ CompletionFunc = userComp
+			var _ CompletionFunc = userComp //nolint:staticcheck // LHS type is needed for this use case
 
 			// check Command accepts
 			cmd := Command{
@@ -2913,8 +2913,7 @@ func TestCompletionFuncCompatibility(t *testing.T) {
 			var userComp func(cmd *Command, args []string, toComplete string) ([]Completion, ShellCompDirective)
 
 			// check against new signature
-			var _ CompletionFunc = userComp
-
+			var _ CompletionFunc = userComp //nolint:staticcheck // LHS type is needed for this use case
 			// check Command accepts
 			cmd := Command{
 				ValidArgsFunction: userComp,
@@ -2927,8 +2926,8 @@ func TestCompletionFuncCompatibility(t *testing.T) {
 			var userComp CompletionFunc
 
 			// check helper against old signature
-			var _ func(cmd *Command, args []string, toComplete string) ([]string, ShellCompDirective) = userComp
-			var _ func(cmd *Command, args []string, toComplete string) ([]Completion, ShellCompDirective) = userComp
+			var _ func(cmd *Command, args []string, toComplete string) ([]string, ShellCompDirective) = userComp     //nolint:staticcheck // LHS type is needed for this use case
+			var _ func(cmd *Command, args []string, toComplete string) ([]Completion, ShellCompDirective) = userComp //nolint:staticcheck // LHS type is needed for this use case
 
 			// check Command accepts
 			cmd := Command{
@@ -2967,7 +2966,7 @@ func TestCompletionFuncCompatibility(t *testing.T) {
 			var userComp UserCompletionTypeAliasHelper
 
 			// Here we are validating the existing type validates the CompletionFunc type
-			var _ CompletionFunc = userComp
+			var _ CompletionFunc = userComp //nolint:staticcheck // LHS type is needed for this use case
 
 			cmd := Command{
 				ValidArgsFunction: userComp,
diff --git a/doc/man_docs.go b/doc/man_docs.go
@@ -212,7 +212,7 @@ func genMan(cmd *cobra.Command, header *GenManHeader) []byte {
 	manPrintOptions(buf, cmd)
 	if len(cmd.Example) > 0 {
 		buf.WriteString("# EXAMPLE\n")
-		buf.WriteString(fmt.Sprintf("```\n%s\n```\n", cmd.Example))
+		fmt.Fprintf(buf, "```\n%s\n```\n", cmd.Example)
 	}
 	if hasSeeAlso(cmd) {
 		buf.WriteString("# SEE ALSO\n")
@@ -240,7 +240,7 @@ func genMan(cmd *cobra.Command, header *GenManHeader) []byte {
 		buf.WriteString(strings.Join(seealsos, ", ") + "\n")
 	}
 	if !cmd.DisableAutoGenTag {
-		buf.WriteString(fmt.Sprintf("# HISTORY\n%s Auto generated by spf13/cobra\n", header.Date.Format("2-Jan-2006")))
+		fmt.Fprintf(buf, "# HISTORY\n%s Auto generated by spf13/cobra\n", header.Date.Format("2-Jan-2006"))
 	}
 	return buf.Bytes()
 }
diff --git a/doc/md_docs.go b/doc/md_docs.go
@@ -69,12 +69,12 @@ func GenMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string)
 	}
 
 	if cmd.Runnable() {
-		buf.WriteString(fmt.Sprintf("```\n%s\n```\n\n", cmd.UseLine()))
+		fmt.Fprintf(buf, "```\n%s\n```\n\n", cmd.UseLine())
 	}
 
 	if len(cmd.Example) > 0 {
 		buf.WriteString("### Examples\n\n")
-		buf.WriteString(fmt.Sprintf("```\n%s\n```\n\n", cmd.Example))
+		fmt.Fprintf(buf, "```\n%s\n```\n\n", cmd.Example)
 	}
 
 	if err := printOptions(buf, cmd, name); err != nil {
@@ -87,7 +87,7 @@ func GenMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string)
 			pname := parent.CommandPath()
 			link := pname + markdownExtension
 			link = strings.ReplaceAll(link, " ", "_")
-			buf.WriteString(fmt.Sprintf("* [%s](%s)\t - %s\n", pname, linkHandler(link), parent.Short))
+			fmt.Fprintf(buf, "* [%s](%s)\t - %s\n", pname, linkHandler(link), parent.Short)
 			cmd.VisitParents(func(c *cobra.Command) {
 				if c.DisableAutoGenTag {
 					cmd.DisableAutoGenTag = c.DisableAutoGenTag
@@ -105,7 +105,7 @@ func GenMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string)
 			cname := name + " " + child.Name()
 			link := cname + markdownExtension
 			link = strings.ReplaceAll(link, " ", "_")
-			buf.WriteString(fmt.Sprintf("* [%s](%s)\t - %s\n", cname, linkHandler(link), child.Short))
+			fmt.Fprintf(buf, "* [%s](%s)\t - %s\n", cname, linkHandler(link), child.Short)
 		}
 		buf.WriteString("\n")
 	}
diff --git a/doc/rest_docs.go b/doc/rest_docs.go
@@ -82,13 +82,13 @@ func GenReSTCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string, str
 	buf.WriteString("\n" + long + "\n\n")
 
 	if cmd.Runnable() {
-		buf.WriteString(fmt.Sprintf("::\n\n  %s\n\n", cmd.UseLine()))
+		fmt.Fprintf(buf, "::\n\n  %s\n\n", cmd.UseLine())
 	}
 
 	if len(cmd.Example) > 0 {
 		buf.WriteString("Examples\n")
 		buf.WriteString("~~~~~~~~\n\n")
-		buf.WriteString(fmt.Sprintf("::\n\n%s\n\n", indentString(cmd.Example, "  ")))
+		fmt.Fprintf(buf, "::\n\n%s\n\n", indentString(cmd.Example, "  "))
 	}
 
 	if err := printOptionsReST(buf, cmd, name); err != nil {
@@ -101,7 +101,7 @@ func GenReSTCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string, str
 			parent := cmd.Parent()
 			pname := parent.CommandPath()
 			ref = strings.ReplaceAll(pname, " ", "_")
-			buf.WriteString(fmt.Sprintf("* %s \t - %s\n", linkHandler(pname, ref), parent.Short))
+			fmt.Fprintf(buf, "* %s \t - %s\n", linkHandler(pname, ref), parent.Short)
 			cmd.VisitParents(func(c *cobra.Command) {
 				if c.DisableAutoGenTag {
 					cmd.DisableAutoGenTag = c.DisableAutoGenTag
@@ -118,7 +118,7 @@ func GenReSTCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string, str
 			}
 			cname := name + " " + child.Name()
 			ref = strings.ReplaceAll(cname, " ", "_")
-			buf.WriteString(fmt.Sprintf("* %s \t - %s\n", linkHandler(cname, ref), child.Short))
+			fmt.Fprintf(buf, "* %s \t - %s\n", linkHandler(cname, ref), child.Short)
 		}
 		buf.WriteString("\n")
 	}
diff --git a/doc/yaml_docs.go b/doc/yaml_docs.go
@@ -153,7 +153,7 @@ func genFlagResult(flags *pflag.FlagSet) []cmdOption {
 		// Todo, when we mark a shorthand is deprecated, but specify an empty message.
 		// The flag.ShorthandDeprecated is empty as the shorthand is deprecated.
 		// Using len(flag.ShorthandDeprecated) > 0 can't handle this, others are ok.
-		if !(len(flag.ShorthandDeprecated) > 0) && len(flag.Shorthand) > 0 {
+		if len(flag.ShorthandDeprecated) == 0 && len(flag.Shorthand) > 0 {
 			opt := cmdOption{
 				flag.Name,
 				flag.Shorthand,

Original file line number	Diff line number	Diff line change
`@@ -212,7 +212,7 @@ func genMan(cmd cobra.Command, header GenManHeader) []byte {`
`212`	`212`	`manPrintOptions(buf, cmd)`
`213`	`213`	`if len(cmd.Example) > 0 {`
`214`	`214`	`buf.WriteString("# EXAMPLE\n")`
`215`		- buf.WriteString(fmt.Sprintf("```\n%s\n```\n", cmd.Example))
	`215`	+ fmt.Fprintf(buf, "```\n%s\n```\n", cmd.Example)
`216`	`216`	`}`
`217`	`217`	`if hasSeeAlso(cmd) {`
`218`	`218`	`buf.WriteString("# SEE ALSO\n")`
`@@ -240,7 +240,7 @@ func genMan(cmd cobra.Command, header GenManHeader) []byte {`
`240`	`240`	`buf.WriteString(strings.Join(seealsos, ", ") + "\n")`
`241`	`241`	`}`
`242`	`242`	`if !cmd.DisableAutoGenTag {`
`243`		`- buf.WriteString(fmt.Sprintf("# HISTORY\n%s Auto generated by spf13/cobra\n", header.Date.Format("2-Jan-2006")))`
	`243`	`+ fmt.Fprintf(buf, "# HISTORY\n%s Auto generated by spf13/cobra\n", header.Date.Format("2-Jan-2006"))`
`244`	`244`	`}`
`245`	`245`	`return buf.Bytes()`
`246`	`246`	`}`
Original file line number	Diff line number	Diff line change
`@@ -69,12 +69,12 @@ func GenMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string)`
`69`	`69`	`}`
`70`	`70`
`71`	`71`	`if cmd.Runnable() {`
`72`		- buf.WriteString(fmt.Sprintf("```\n%s\n```\n\n", cmd.UseLine()))
	`72`	+ fmt.Fprintf(buf, "```\n%s\n```\n\n", cmd.UseLine())
`73`	`73`	`}`
`74`	`74`
`75`	`75`	`if len(cmd.Example) > 0 {`
`76`	`76`	`buf.WriteString("### Examples\n\n")`
`77`		- buf.WriteString(fmt.Sprintf("```\n%s\n```\n\n", cmd.Example))
	`77`	+ fmt.Fprintf(buf, "```\n%s\n```\n\n", cmd.Example)
`78`	`78`	`}`
`79`	`79`
`80`	`80`	`if err := printOptions(buf, cmd, name); err != nil {`
`@@ -87,7 +87,7 @@ func GenMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string)`
`87`	`87`	`pname := parent.CommandPath()`
`88`	`88`	`link := pname + markdownExtension`
`89`	`89`	`link = strings.ReplaceAll(link, " ", "_")`
`90`		`- buf.WriteString(fmt.Sprintf("* [%s](%s)\t - %s\n", pname, linkHandler(link), parent.Short))`
	`90`	`+ fmt.Fprintf(buf, "* [%s](%s)\t - %s\n", pname, linkHandler(link), parent.Short)`
`91`	`91`	`cmd.VisitParents(func(c *cobra.Command) {`
`92`	`92`	`if c.DisableAutoGenTag {`
`93`	`93`	`cmd.DisableAutoGenTag = c.DisableAutoGenTag`
`@@ -105,7 +105,7 @@ func GenMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string)`
`105`	`105`	`cname := name + " " + child.Name()`
`106`	`106`	`link := cname + markdownExtension`
`107`	`107`	`link = strings.ReplaceAll(link, " ", "_")`
`108`		`- buf.WriteString(fmt.Sprintf("* [%s](%s)\t - %s\n", cname, linkHandler(link), child.Short))`
	`108`	`+ fmt.Fprintf(buf, "* [%s](%s)\t - %s\n", cname, linkHandler(link), child.Short)`
`109`	`109`	`}`
`110`	`110`	`buf.WriteString("\n")`
`111`	`111`	`}`
Original file line number	Diff line number	Diff line change
`@@ -82,13 +82,13 @@ func GenReSTCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string, str`
`82`	`82`	`buf.WriteString("\n" + long + "\n\n")`
`83`	`83`
`84`	`84`	`if cmd.Runnable() {`
`85`		`- buf.WriteString(fmt.Sprintf("::\n\n %s\n\n", cmd.UseLine()))`
	`85`	`+ fmt.Fprintf(buf, "::\n\n %s\n\n", cmd.UseLine())`
`86`	`86`	`}`
`87`	`87`
`88`	`88`	`if len(cmd.Example) > 0 {`
`89`	`89`	`buf.WriteString("Examples\n")`
`90`	`90`	`buf.WriteString("~~~~~~~~\n\n")`
`91`		`- buf.WriteString(fmt.Sprintf("::\n\n%s\n\n", indentString(cmd.Example, " ")))`
	`91`	`+ fmt.Fprintf(buf, "::\n\n%s\n\n", indentString(cmd.Example, " "))`
`92`	`92`	`}`
`93`	`93`
`94`	`94`	`if err := printOptionsReST(buf, cmd, name); err != nil {`
`@@ -101,7 +101,7 @@ func GenReSTCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string, str`
`101`	`101`	`parent := cmd.Parent()`
`102`	`102`	`pname := parent.CommandPath()`
`103`	`103`	`ref = strings.ReplaceAll(pname, " ", "_")`
`104`		`- buf.WriteString(fmt.Sprintf("* %s \t - %s\n", linkHandler(pname, ref), parent.Short))`
	`104`	`+ fmt.Fprintf(buf, "* %s \t - %s\n", linkHandler(pname, ref), parent.Short)`
`105`	`105`	`cmd.VisitParents(func(c *cobra.Command) {`
`106`	`106`	`if c.DisableAutoGenTag {`
`107`	`107`	`cmd.DisableAutoGenTag = c.DisableAutoGenTag`
`@@ -118,7 +118,7 @@ func GenReSTCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string, str`
`118`	`118`	`}`
`119`	`119`	`cname := name + " " + child.Name()`
`120`	`120`	`ref = strings.ReplaceAll(cname, " ", "_")`
`121`		`- buf.WriteString(fmt.Sprintf("* %s \t - %s\n", linkHandler(cname, ref), child.Short))`
	`121`	`+ fmt.Fprintf(buf, "* %s \t - %s\n", linkHandler(cname, ref), child.Short)`
`122`	`122`	`}`
`123`	`123`	`buf.WriteString("\n")`
`124`	`124`	`}`