Merge pull request #1368 from Adirio/go-report-card

Fix issues raised by Go Report Card

Author: k8s-ci-robot

cmd/api.go

@@ -206,7 +206,7 @@ func (o *apiOptions) validate(c *config.Config) error {
 
 func (o *apiOptions) scaffolder(c *config.Config) (scaffold.Scaffolder, error) {
 	// Load the boilerplate
-	bp, err := ioutil.ReadFile(filepath.Join("hack", "boilerplate.go.txt")) // nolint:gosec
+	bp, err := ioutil.ReadFile(filepath.Join("hack", "boilerplate.go.txt")) //nolint:gosec
 	if err != nil {
 		return nil, fmt.Errorf("unable to load boilerplate: %v", err)
 	}

cmd/edit.go

@@ -89,7 +89,7 @@ func (o *editOptions) validate(c *config.Config) error {
 	return nil
 }
 
-func (o *editOptions) scaffolder(c *config.Config) (scaffold.Scaffolder, error) { // nolint:unparam
+func (o *editOptions) scaffolder(c *config.Config) (scaffold.Scaffolder, error) { //nolint:unparam
 	return scaffold.NewEditScaffolder(c, o.multigroup), nil
 }
 

cmd/init.go

@@ -179,7 +179,7 @@ func (o *initOptions) validate(c *config.Config) error {
 	return nil
 }
 
-func (o *initOptions) scaffolder(c *config.Config) (scaffold.Scaffolder, error) { // nolint:unparam
+func (o *initOptions) scaffolder(c *config.Config) (scaffold.Scaffolder, error) { //nolint:unparam
 	return scaffold.NewInitScaffolder(c, o.license, o.owner), nil
 }
 

cmd/internal/config.go

@@ -43,6 +43,7 @@ func ConfiguredAndV1() bool {
 	return projectConfig.IsV1()
 }
 
+// PrintV1DeprecationWarning prints a deprecation warning if some v1 feature is used
 func PrintV1DeprecationWarning() {
 	fmt.Printf(noticeColor, "[Deprecation Notice] The v1 projects are deprecated and will not be supported beyond "+
 		"Feb 1, 2020.\nSee how to upgrade your project to v2: https://book.kubebuilder.io/migration/guide.html\n")

cmd/internal/exec.go

@@ -23,8 +23,9 @@ import (
 	"strings"
 )
 
+// RunCmd prints the provided message and command and then executes it binding stdout and stderr
 func RunCmd(msg, cmd string, args ...string) error {
-	c := exec.Command(cmd, args...) // #nolint:gosec
+	c := exec.Command(cmd, args...) //nolint:gosec
 	c.Stdout = os.Stdout
 	c.Stderr = os.Stderr
 	fmt.Println(msg + ":\n$ " + strings.Join(c.Args, " "))

cmd/internal/go_version.go

@@ -24,6 +24,7 @@ import (
 	"strings"
 )
 
+// ValidateGoVersion verifies that Go is installed and the current go version is supported by kubebuilder
 func ValidateGoVersion() error {
 	err := fetchAndCheckGoVersion()
 	if err != nil {

cmd/update.go

@@ -81,7 +81,7 @@ func (o *updateOptions) validate(c *config.Config) error {
 	return nil
 }
 
-func (o *updateOptions) scaffolder(c *config.Config) (scaffold.Scaffolder, error) { // nolint:unparam
+func (o *updateOptions) scaffolder(c *config.Config) (scaffold.Scaffolder, error) { //nolint:unparam
 	return scaffold.NewUpdateScaffolder(&c.Config), nil
 }
 

cmd/version/version.go

@@ -34,6 +34,7 @@ var (
 	buildDate = "1970-01-01T00:00:00Z" // build date in ISO8601 format, output of $(date -u +'%Y-%m-%dT%H:%M:%SZ')
 )
 
+// Version contains all the information related to the CLI version
 type Version struct {
 	KubeBuilderVersion string `json:"kubeBuilderVersion"`
 	KubernetesVendor   string `json:"kubernetesVendor"`
@@ -54,10 +55,12 @@ func getVersion() Version {
 	}
 }
 
+// Print prints the CLI version
 func (v Version) Print() {
 	fmt.Printf("Version: %#v\n", v)
 }
 
+// NewVersionCmd creates a new command that prints the CLI version
 func NewVersionCmd() *cobra.Command {
 	return &cobra.Command{
 		Use:     "version",

cmd/webhook.go

@@ -114,7 +114,7 @@ func (o *webhookV1Options) validate(c *config.Config) error {
 
 func (o *webhookV1Options) scaffolder(c *config.Config) (scaffold.Scaffolder, error) {
 	// Load the boilerplate
-	bp, err := ioutil.ReadFile(filepath.Join("hack", "boilerplate.go.txt")) // nolint:gosec
+	bp, err := ioutil.ReadFile(filepath.Join("hack", "boilerplate.go.txt")) //nolint:gosec
 	if err != nil {
 		return nil, fmt.Errorf("unable to load boilerplate: %v", err)
 	}
@@ -220,9 +220,9 @@ func (o *webhookV2Options) validate(c *config.Config) error {
 	return nil
 }
 
-func (o *webhookV2Options) scaffolder(c *config.Config) (scaffold.Scaffolder, error) { // nolint:unparam
+func (o *webhookV2Options) scaffolder(c *config.Config) (scaffold.Scaffolder, error) { //nolint:unparam
 	// Load the boilerplate
-	bp, err := ioutil.ReadFile(filepath.Join("hack", "boilerplate.go.txt")) // nolint:gosec
+	bp, err := ioutil.ReadFile(filepath.Join("hack", "boilerplate.go.txt")) //nolint:gosec
 	if err != nil {
 		return nil, fmt.Errorf("unable to load boilerplate: %v", err)
 	}

docs/book/utils/litgo/literate.go

@@ -45,7 +45,10 @@ type Literate struct {
 	BaseSourcePath *url.URL
 }
 
-func (_ Literate) SupportsOutput(_ string) bool { return true }
+// SupportsOutput implements plugin.Plugin
+func (Literate) SupportsOutput(_ string) bool { return true }
+
+// Process implements plugin.Plugin
 func (l Literate) Process(input *plugin.Input) error {
 	bookSrcDir := filepath.Join(input.Context.Root, input.Context.Config.Book.Src)
 	return plugin.EachCommand(&input.Book, "literatego", func(chapter *plugin.BookChapter, relPath string) (string, error) {