Put rule ID suffix on new line when rule message is multi-line

Readability of rule message output may be improved by inserting strategic line breaks. In this case, the current behavior
of appending the rule ID suffix to the non-verbose rule violation output on the same line will not always be appropriate.
So when the rule message contains explicit line breaks, the rule ID should be appended on a new line, with the previous
behavior preserved in the case of single line rule messages (which will be wrapped according to the column size).

Author: per1234

Diff for: internal/result/result.go

@@ -144,7 +144,11 @@ func (results *Type) Record(lintedProject project.Type, ruleConfiguration ruleco
 		}
 	} else {
 		if ruleResult == ruleresult.Fail {
-			summaryText = formatRuleText(ruleLevel, fmt.Sprintf("%s (Rule %s)", ruleMessage, ruleConfiguration.ID))
+			if strings.Contains(ruleMessage, "\n") {
+				summaryText = formatRuleText(ruleLevel, fmt.Sprintf("%s\n(Rule %s)", ruleMessage, ruleConfiguration.ID))
+			} else {
+				summaryText = formatRuleText(ruleLevel, fmt.Sprintf("%s (Rule %s)", ruleMessage, ruleConfiguration.ID))
+			}
 		}
 	}
 

Diff for: internal/result/result_test.go

@@ -85,9 +85,15 @@ func TestRecord(t *testing.T) {
 	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)
-	outputAssertion = "ERROR: Path does not contain a valid Arduino library. See:                                                              \n       https://arduino.github.io/arduino-cli/latest/library-specification (Rule LS001)                                  \n"
-	assert.Equal(t, outputAssertion, summaryText)
+	ruleConfigurationCopy := ruleConfiguration
+	ruleConfigurationCopy.MessageTemplate = "bar"
+	summaryText = results.Record(lintedProject, ruleConfigurationCopy, ruleresult.Fail, ruleOutput)
+	outputAssertion = "ERROR: bar (Rule LS001)\n"
+	assert.Equal(t, outputAssertion, summaryText, "Rule ID is appended to non-verbose fail message on same line when rule message is single line")
+	ruleConfigurationCopy.MessageTemplate = "bar\nbaz"
+	summaryText = results.Record(lintedProject, ruleConfigurationCopy, ruleresult.Fail, ruleOutput)
+	outputAssertion = "ERROR: bar         \n       baz         \n       (Rule LS001)\n"
+	assert.Equal(t, outputAssertion, summaryText, "Rule ID is appended to non-verbose fail message on same line when rule message is multiple lines")
 	summaryText = results.Record(lintedProject, ruleConfiguration, ruleresult.NotRun, ruleOutput)
 	assert.Equal(t, "", summaryText, "Non-fail result should not result in output in non-verbose mode")
 	summaryText = results.Record(lintedProject, ruleConfiguration, ruleresult.Pass, "")