Go code cleanup (#1148)

- Use short form `if err := ...; err != nil {` statements where applicable.
- Extract some of the larger raw strings out of tests and into testdata

Signed-off-by: Anders Eknert <anders@styra.com>

build/dprint.json

@@ -3,7 +3,9 @@
     "indentBlockSequenceInMap": true
   },
   "json": {},
-  "excludes": [],
+  "excludes": [
+    "**/testdata/**"
+  ],
   "plugins": [
     "https://plugins.dprint.dev/g-plane/pretty_yaml-v0.5.0.wasm",
     "https://plugins.dprint.dev/json-0.19.3.wasm"

cmd/fix.go

@@ -98,8 +98,7 @@ The linter rules with automatic fixes available are currently:
 		},
 
 		RunE: wrapProfiling(func(args []string) error {
-			err := fix(args, params)
-			if err != nil {
+			if err := fix(args, params); err != nil {
 				log.SetOutput(os.Stderr)
 				log.Println(err)
 
@@ -339,8 +338,7 @@ func fix(args []string, params *fixCommandParams) error {
 	}
 
 	if fixReport.HasConflicts() {
-		err = r.Report(fixReport)
-		if err != nil {
+		if err = r.Report(fixReport); err != nil {
 			return fmt.Errorf("failed to output fix report: %w", err)
 		}
 
@@ -425,8 +423,7 @@ please run fix from a clean state to support the use of git checkout for undo`,
 			}
 
 			for _, dir := range dirs {
-				err := os.Remove(dir)
-				if err != nil {
+				if err := os.Remove(dir); err != nil {
 					return fmt.Errorf("failed to delete directory %s: %w", dir, err)
 				}
 			}
@@ -445,20 +442,17 @@ please run fix from a clean state to support the use of git checkout for undo`,
 				fileMode = fileInfo.Mode()
 			}
 
-			err = os.MkdirAll(filepath.Dir(file), 0o755)
-			if err != nil {
+			if err = os.MkdirAll(filepath.Dir(file), 0o755); err != nil {
 				return fmt.Errorf("failed to create directory for file %s: %w", file, err)
 			}
 
-			err = os.WriteFile(file, fc, fileMode)
-			if err != nil {
+			if err = os.WriteFile(file, fc, fileMode); err != nil {
 				return fmt.Errorf("failed to write file %s: %w", file, err)
 			}
 		}
 	}
 
-	err = r.Report(fixReport)
-	if err != nil {
+	if err = r.Report(fixReport); err != nil {
 		return fmt.Errorf("failed to output fix report: %w", err)
 	}
 

cmd/lint.go

@@ -422,8 +422,7 @@ func formatError(format string, err error) error {
 
 		buf := &bytes.Buffer{}
 
-		err := testSuites.WriteXML(buf)
-		if err != nil {
+		if err := testSuites.WriteXML(buf); err != nil {
 			return fmt.Errorf("failed to format errors for output: %w", err)
 		}
 

cmd/new.go

@@ -206,8 +206,7 @@ func addToDataYAML(params newRuleCommandParams) error {
 	yamlEncoder := yaml.NewEncoder(&b)
 	yamlEncoder.SetIndent(2)
 
-	err = yamlEncoder.Encode(existingConfig)
-	if err != nil {
+	if err = yamlEncoder.Encode(existingConfig); err != nil {
 		return err
 	}
 
@@ -241,8 +240,7 @@ func scaffoldCustomRule(params newRuleCommandParams) error {
 		return err
 	}
 
-	err = ruleTmpl.Execute(ruleFile, templateValues(params))
-	if err != nil {
+	if err = ruleTmpl.Execute(ruleFile, templateValues(params)); err != nil {
 		return err
 	}
 
@@ -258,8 +256,7 @@ func scaffoldCustomRule(params newRuleCommandParams) error {
 		return err
 	}
 
-	err = testTmpl.Execute(testFile, templateValues(params))
-	if err != nil {
+	if err = testTmpl.Execute(testFile, templateValues(params)); err != nil {
 		return err
 	}
 
@@ -287,8 +284,7 @@ func scaffoldBuiltinRule(params newRuleCommandParams) error {
 		return err
 	}
 
-	err = ruleTmpl.Execute(ruleFile, templateValues(params))
-	if err != nil {
+	if err = ruleTmpl.Execute(ruleFile, templateValues(params)); err != nil {
 		return err
 	}
 
@@ -304,8 +300,7 @@ func scaffoldBuiltinRule(params newRuleCommandParams) error {
 		return err
 	}
 
-	err = testTmpl.Execute(testFile, templateValues(params))
-	if err != nil {
+	if err = testTmpl.Execute(testFile, templateValues(params)); err != nil {
 		return err
 	}
 
@@ -335,8 +330,7 @@ func createBuiltinDocs(params newRuleCommandParams) error {
 		return err
 	}
 
-	err = docTmpl.Execute(docFile, templateValues(params))
-	if err != nil {
+	if err = docTmpl.Execute(docFile, templateValues(params)); err != nil {
 		return err
 	}
 

cmd/version.go

@@ -40,8 +40,7 @@ func init() {
 			case formatJSON:
 				e := encoding.JSON().NewEncoder(os.Stdout)
 				e.SetIndent("", "  ")
-				err := e.Encode(vi)
-				if err != nil {
+				if err := e.Encode(vi); err != nil {
 					log.SetOutput(os.Stderr)
 					log.Println(err)
 					os.Exit(1)