Use an "enum" for the output format types

Author: per1234

check/check.go

@@ -11,6 +11,7 @@ import (
 	"github.com/arduino/arduino-check/configuration/checkmode"
 	"github.com/arduino/arduino-check/project"
 	"github.com/arduino/arduino-check/result"
+	"github.com/arduino/arduino-check/result/outputformat"
 	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/feedback"
 	"github.com/sirupsen/logrus"
@@ -35,20 +36,20 @@ func RunChecks(project project.Type) {
 		}
 
 		// Output will be printed after all checks are finished when configured for "json" output format
-		if configuration.OutputFormat() == "text" {
+		if configuration.OutputFormat() == outputformat.Text {
 			fmt.Printf("Running check %s: ", checkConfiguration.ID)
 		}
 		checkResult, checkOutput := checkConfiguration.CheckFunction()
 		reportText := result.Results.Record(project, checkConfiguration, checkResult, checkOutput)
-		if configuration.OutputFormat() == "text" {
+		if configuration.OutputFormat() == outputformat.Text {
 			fmt.Print(reportText)
 		}
 	}
 
 	// Checks are finished for this project, so summarize its check results in the report.
 	result.Results.AddProjectSummary(project)
 
-	if configuration.OutputFormat() == "text" {
+	if configuration.OutputFormat() == outputformat.Text {
 		// Print the project check results summary.
 		fmt.Print(result.Results.ProjectSummaryText(project))
 	}

configuration/configuration.go

@@ -4,6 +4,7 @@ package configuration
 import (
 	"github.com/arduino/arduino-check/configuration/checkmode"
 	"github.com/arduino/arduino-check/project/projecttype"
+	"github.com/arduino/arduino-check/result/outputformat"
 	"github.com/arduino/arduino-cli/cli/feedback"
 	"github.com/arduino/go-paths-helper"
 	"github.com/sirupsen/logrus"
@@ -26,8 +27,8 @@ func Initialize() {
 	// customCheckModes[checkmode.Official] = false
 	// superprojectType = projecttype.All
 
-	outputFormat = "text"
-	//outputFormat = "json"
+	//outputFormat = outputformat.Text
+	//outputFormat = outputformat.JSON
 	//reportFilePath = paths.New("report.json")
 
 	feedback.SetFormat(feedback.JSON)
@@ -61,10 +62,10 @@ func Recursive() bool {
 	return recursive
 }
 
-var outputFormat string
+var outputFormat outputformat.Type
 
 // OutputFormat returns the tool output format configuration value.
-func OutputFormat() string {
+func OutputFormat() outputformat.Type {
 	return outputFormat
 }
 

configuration/defaults.go

@@ -5,12 +5,13 @@ package configuration
 import (
 	"github.com/arduino/arduino-check/configuration/checkmode"
 	"github.com/arduino/arduino-check/project/projecttype"
+	"github.com/arduino/arduino-check/result/outputformat"
 )
 
 func setDefaults() {
 	superprojectTypeFilter = projecttype.All
 	recursive = true
-	outputFormat = "text"
+	outputFormat = outputformat.Text
 	// TODO: targetPath defaults to current path
 }
 

main.go

@@ -8,6 +8,7 @@ import (
 	"github.com/arduino/arduino-check/configuration"
 	"github.com/arduino/arduino-check/project"
 	"github.com/arduino/arduino-check/result"
+	"github.com/arduino/arduino-check/result/outputformat"
 	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/feedback"
 )
@@ -30,7 +31,7 @@ func main() {
 	// All projects have been checked, so summarize their check results in the report.
 	result.Results.AddSummary()
 
-	if configuration.OutputFormat() == "text" {
+	if configuration.OutputFormat() == outputformat.Text {
 		if len(projects) > 1 {
 			// There are multiple projects, print the summary of check results for all projects.
 			fmt.Print(result.Results.SummaryText())

result/outputformat/outputformat.go

@@ -0,0 +1,11 @@
+// Package projecttype defines the output formats
+package outputformat
+
+// Type is the type for output formats
+//go:generate stringer -type=Type -linecomment
+type Type int
+
+const (
+	Text Type = iota // text
+	JSON             // JSON
+)