Move rule output control logic to result package

Since output always has had the same format regardless of the tool configuration, with the configuration only determining
whether or not it will be printed, it made sense to place the printing control logic at the point of printing, always
outputting the message from the result package.

It has now been determined that there are different formatting requirements for verbose and non-verbose output. This
means that it makes more sense to move that logic to the result package and simply return an empty string when no output
should be printed. This refactoring in preparation for the formatting changes to the non-verbose output.

Author: per1234

internal/result/result.go

@@ -101,8 +101,6 @@ func (results *Type) Record(lintedProject project.Type, ruleConfiguration ruleco
 		panic(fmt.Errorf("Error while determining rule level: %v", err))
 	}
 
-	summaryText := fmt.Sprintf("Rule %s result: %s", ruleConfiguration.ID, ruleResult)
-
 	ruleMessage := ""
 	if ruleResult == ruleresult.Fail {
 		ruleMessage = message(ruleConfiguration.MessageTemplate, ruleOutput)
@@ -112,9 +110,14 @@ func (results *Type) Record(lintedProject project.Type, ruleConfiguration ruleco
 		ruleMessage = ruleOutput
 	}
 
-	// Add explanation of rule result if present.
-	if ruleMessage != "" {
-		summaryText += fmt.Sprintf("\n%s: %s", ruleLevel, ruleMessage)
+	summaryText := ""
+	if (ruleResult == ruleresult.Fail) || configuration.Verbose() {
+		summaryText = fmt.Sprintf("Rule %s result: %s", ruleConfiguration.ID, ruleResult)
+		// Add explanation of rule result if present.
+		if ruleMessage != "" {
+			summaryText += fmt.Sprintf("\n%s: %s", ruleLevel, ruleMessage)
+		}
+		summaryText += "\n"
 	}
 
 	reportExists, projectReportIndex := results.getProjectReportIndex(lintedProject.Path)

internal/result/result_test.go

@@ -74,12 +74,22 @@ func TestRecord(t *testing.T) {
 	results.Initialize()
 	ruleConfiguration := ruleconfiguration.Configurations()[0]
 	ruleOutput := "foo"
+	flags.Set("verbose", "true")
+	require.Nil(t, configuration.Initialize(flags, projectPaths))
 	summaryText := results.Record(lintedProject, ruleConfiguration, ruleresult.Fail, ruleOutput)
-	assert.Equal(t, fmt.Sprintf("Rule %s result: %s\n%s: %s", ruleConfiguration.ID, ruleresult.Fail, rulelevel.Error, message(ruleConfiguration.MessageTemplate, ruleOutput)), summaryText)
+	assert.Equal(t, fmt.Sprintf("Rule %s result: %s\n%s: %s\n", ruleConfiguration.ID, ruleresult.Fail, rulelevel.Error, message(ruleConfiguration.MessageTemplate, ruleOutput)), summaryText)
+	summaryText = results.Record(lintedProject, ruleConfiguration, ruleresult.NotRun, ruleOutput)
+	assert.Equal(t, fmt.Sprintf("Rule %s result: %s\n%s: %s\n", ruleConfiguration.ID, ruleresult.NotRun, rulelevel.Notice, ruleOutput), summaryText, "Non-fail result should not use message")
+	summaryText = results.Record(lintedProject, ruleConfiguration, ruleresult.Pass, "")
+	assert.Equal(t, fmt.Sprintf("Rule %s result: %s\n", ruleConfiguration.ID, ruleresult.Pass), summaryText, "Non-failure result with no rule function output should only use preface")
+	flags.Set("verbose", "false")
+	require.Nil(t, configuration.Initialize(flags, projectPaths))
+	summaryText = results.Record(lintedProject, ruleConfiguration, ruleresult.Fail, ruleOutput)
+	assert.Equal(t, fmt.Sprintf("Rule %s result: %s\n%s: %s\n", ruleConfiguration.ID, ruleresult.Fail, rulelevel.Error, message(ruleConfiguration.MessageTemplate, ruleOutput)), summaryText)
 	summaryText = results.Record(lintedProject, ruleConfiguration, ruleresult.NotRun, ruleOutput)
-	assert.Equal(t, fmt.Sprintf("Rule %s result: %s\n%s: %s", ruleConfiguration.ID, ruleresult.NotRun, rulelevel.Notice, ruleOutput), summaryText, "Non-fail result should not use message")
+	assert.Equal(t, "", summaryText, "Non-fail result should not result in output in non-verbose mode")
 	summaryText = results.Record(lintedProject, ruleConfiguration, ruleresult.Pass, "")
-	assert.Equal(t, fmt.Sprintf("Rule %s result: %s", ruleConfiguration.ID, ruleresult.Pass), summaryText, "Non-failure result with no rule function output should only use preface")
+	assert.Equal(t, "", summaryText, "Non-fail result should not result in output in non-verbose mode")
 
 	flags.Set("verbose", "true")
 	require.Nil(t, configuration.Initialize(flags, projectPaths))

internal/rule/rule.go

@@ -26,7 +26,6 @@ import (
 	"github.com/arduino/arduino-lint/internal/result"
 	"github.com/arduino/arduino-lint/internal/result/feedback"
 	"github.com/arduino/arduino-lint/internal/rule/ruleconfiguration"
-	"github.com/arduino/arduino-lint/internal/rule/ruleresult"
 	"github.com/sirupsen/logrus"
 )
 
@@ -52,9 +51,7 @@ func Runner(project project.Type) {
 
 		ruleResult, ruleOutput := ruleConfiguration.RuleFunction()
 		reportText := result.Results.Record(project, ruleConfiguration, ruleResult, ruleOutput)
-		if (ruleResult == ruleresult.Fail) || configuration.Verbose() {
-			feedback.Println(reportText)
-		}
+		feedback.Print(reportText)
 	}
 }