Merge pull request rancher-sandbox#8356 from mook-as/golangci-lint/stylecheck

golangci-lint: Add stylecheck

Author: jandubois

.github/actions/spelling/expect.txt

@@ -394,7 +394,9 @@ JOBOBJECT
 joycelin
 jpe
 jsmith
+JSONOr
 jsontable
+JSONTo
 julianb
 karl
 Kaspersky

.golangci.yaml

@@ -62,6 +62,7 @@ linters:
     - ineffassign
     - misspell
     - staticcheck
+    - stylecheck
     - typecheck
     - unconvert
     - unused
@@ -84,6 +85,11 @@ issues:
       text: "ST1005:"
       path: src/go/wsl-helper/cmd/kubeconfig.go
       source: errors.New\("Windows
+    - # Exclude ST1005 when it encounters errors starting with proper noun
+      linters: [ stylecheck ]
+      text: "ST1005:"
+      path: src/go/rdctl/pkg/lock/lock.go
+      source: fmt.Errorf\("Rancher Desktop
     - # Exclude long function declarations
       linters: [ lll ]
       source: ^\s*func\b
@@ -94,3 +100,18 @@ issues:
     - # Ignore errors from syscall
       linters: [ dogsled ]
       source: ^\s*_, _, _ = .*\.Call\(
+    - # Ignore foreign constants
+      path: src/go/rdctl/pkg/process/process_darwin.go
+      linters: [ stylecheck ]
+      text: "ST1003:"
+      source: ^\s*(CTL_KERN|KERN_PROCARGS)\s*=
+    - # Ignore foreign constants
+      path: src/go/rdctl/pkg/process/process_windows.go
+      linters: [ stylecheck ]
+      text: "ST1003:"
+      source: ^\s*type\s+[A-Z0-9_]+\s+struct
+    - # Ignore foreign constants
+      path: src/go/rdctl/pkg/process/process_windows.go
+      linters: [ stylecheck ]
+      text: "ST1003:"
+      source: ^\s*[A-Z0-9_]+\s+=

src/go/docker-credential-none/dcnone/dcnone.go

@@ -114,7 +114,7 @@ func (p DCNone) List() (map[string]string, error) {
 	if ok {
 		auths, ok := authsInterface.(map[string]interface{})
 		if !ok {
-			return entries, fmt.Errorf("Unexpected data: %v: not a hash\n", authsInterface)
+			return entries, fmt.Errorf("unexpected data: %v: not a hash", authsInterface)
 		}
 		for url := range auths {
 			username, _, err := getRecordForServerURL(&config, url)

src/go/docker-credential-none/dcnone/helpers.go

@@ -58,11 +58,11 @@ func getRecordForServerURL(config *dockerConfigType, urlArg string) (string, str
 		return "", "", credentials.NewErrCredentialsNotFound()
 	}
 	auths := authsInterface.(map[string]interface{})
-	authDataForUrl, ok := auths[urlArg]
+	authDataForURL, ok := auths[urlArg]
 	if !ok {
 		return "", "", credentials.NewErrCredentialsNotFound()
 	}
-	authData, ok := authDataForUrl.(map[string]interface{})["auth"]
+	authData, ok := authDataForURL.(map[string]interface{})["auth"]
 	if !ok {
 		return "", "", credentials.NewErrCredentialsNotFound()
 	}

src/go/nerdctl-stub/generate/main_linux.go

@@ -97,11 +97,11 @@ func buildSubcommand(args []string, parentData helpData, writer io.Writer) error
 	logrus.WithField("args", args).Trace("building subcommand")
 	help, err := getHelp(args)
 	if err != nil {
-		return fmt.Errorf("Error getting help for %v: %w", args, err)
+		return fmt.Errorf("error getting help for %v: %w", args, err)
 	}
 	subcommands, err := parseHelp(args, help, parentData)
 	if err != nil {
-		return fmt.Errorf("Error parsing help for %v: %w", args, err)
+		return fmt.Errorf("error parsing help for %v: %w", args, err)
 	}
 
 	err = emitCommand(args, subcommands, writer)

src/go/rdctl/cmd/api.go

@@ -82,7 +82,7 @@ func doAPICommand(cmd *cobra.Command, args []string) error {
 	}
 	endpoint := args[0]
 	if endpoint != "/" && regexp.MustCompile(`^/v\d+(?:/|$)`).FindString(endpoint) == "" {
-		endpoint = fmt.Sprintf("/%s", client.VersionCommand(client.ApiVersion, endpoint))
+		endpoint = fmt.Sprintf("/%s", client.VersionCommand(client.APIVersion, endpoint))
 	}
 	if apiSettings.InputFile != "" && apiSettings.Body != "" {
 		return fmt.Errorf("api command: --body and --input options cannot both be specified")

src/go/rdctl/cmd/createProfile.go

@@ -113,13 +113,13 @@ func createProfile() (string, error) {
 		return "", err
 	}
 	if outputSettingsFlags.Format == regFormat {
-		lines, err := reg.JsonToReg(outputSettingsFlags.RegistryHive, outputSettingsFlags.RegistryProfileType, string(output))
+		lines, err := reg.JSONToReg(outputSettingsFlags.RegistryHive, outputSettingsFlags.RegistryProfileType, string(output))
 		if err != nil {
 			return "", err
 		}
 		return strings.Join(lines, "\n"), nil
 	} else if outputSettingsFlags.Format == plistFormat {
-		return plist.JsonToPlist(string(output))
+		return plist.JSONToPlist(string(output))
 	}
 	return "", fmt.Errorf(`internal error: expecting an output format of %q or %q, got %q`, regFormat, plistFormat, outputSettingsFlags.Format)
 }

src/go/rdctl/cmd/extension.go

@@ -31,7 +31,7 @@ var extensionCmd = &cobra.Command{
 	Use: "extension [install | uninstall | list] [options...]",
 	RunE: func(cmd *cobra.Command, args []string) error {
 		cmd.SilenceUsage = true
-		return fmt.Errorf("No subcommand given.\n\nUsage: rdctl %s", cmd.Use)
+		return fmt.Errorf("no subcommand given.\n\nUsage: rdctl %s", cmd.Use)
 	},
 }
 

src/go/rdctl/cmd/extensionInstall.go

@@ -50,7 +50,7 @@ func installExtension(args []string) error {
 	}
 	rdClient := client.NewRDClient(connectionInfo)
 	imageID := args[0]
-	endpoint := fmt.Sprintf("/%s/extensions/install?id=%s", client.ApiVersion, imageID)
+	endpoint := fmt.Sprintf("/%s/extensions/install?id=%s", client.APIVersion, imageID)
 	// https://stackoverflow.com/questions/20847357/golang-http-client-always-escaped-the-url
 	// Looks like http.NewRequest(method, url) escapes the URL
 

src/go/rdctl/cmd/extensionList.go

@@ -52,7 +52,7 @@ func listExtensions() error {
 		return fmt.Errorf("failed to get connection info: %w", err)
 	}
 	rdClient := client.NewRDClient(connectionInfo)
-	endpoint := fmt.Sprintf("/%s/extensions", client.ApiVersion)
+	endpoint := fmt.Sprintf("/%s/extensions", client.APIVersion)
 	result, errorPacket, err := client.ProcessRequestForAPI(rdClient.DoRequest("GET", endpoint))
 	if errorPacket != nil || err != nil {
 		return displayAPICallResult([]byte{}, errorPacket, err)