Simplify summary output

per1234 · per1234 · commit 6b719bc89b9c · 2021-07-19T11:37:13.000-07:00
This less verbose approach to the project and projects linting summary output provides the same amount of information in
a more approachable format.
diff --git a/internal/result/result.go b/internal/result/result.go
@@ -194,8 +194,15 @@ func (results Type) ProjectSummaryText(lintedProject project.Type) string {
 		panic(fmt.Sprintf("Unable to find report for %v when generating report summary text", lintedProject.Path))
 	}
 
-	projectSummaryReport := results.Projects[projectReportIndex].Summary
-	return fmt.Sprintf("Finished linting project. Results:\nWarning count: %v\nError count: %v\nRules passed: %v", projectSummaryReport.WarningCount, projectSummaryReport.ErrorCount, projectSummaryReport.Pass)
+	projectSummaryReport := "Linter results for project: "
+	projectSummaryData := results.Projects[projectReportIndex].Summary
+	if projectSummaryData.ErrorCount == 0 && projectSummaryData.WarningCount == 0 {
+		projectSummaryReport += "no errors or warnings"
+	} else {
+		projectSummaryReport += fmt.Sprintf("%v ERRORS, %v WARNINGS", projectSummaryData.ErrorCount, projectSummaryData.WarningCount)
+	}
+
+	return projectSummaryReport
 }
 
 // AddSummary summarizes the rule results for all projects and adds it to the report.
@@ -220,7 +227,14 @@ func (results *Type) AddSummary() {
 
 // SummaryText returns a text summary of the cumulative rule results.
 func (results Type) SummaryText() string {
-	return fmt.Sprintf("Finished linting projects. Results:\nWarning count: %v\nError count: %v\nRules passed: %v", results.Summary.WarningCount, results.Summary.ErrorCount, results.Summary.Pass)
+	summaryReport := "Linter results for projects: "
+	if results.Summary.ErrorCount == 0 && results.Summary.WarningCount == 0 {
+		summaryReport += "no errors or warnings"
+	} else {
+		summaryReport += fmt.Sprintf("%v ERRORS, %v WARNINGS", results.Summary.ErrorCount, results.Summary.WarningCount)
+	}
+
+	return summaryReport
 }
 
 // JSONReport returns a JSON formatted report of rules on all projects in string encoding.
diff --git a/internal/result/result_test.go b/internal/result/result_test.go
@@ -207,7 +207,11 @@ func TestAddProjectSummary(t *testing.T) {
 		assert.Equal(t, testTable.expectedPass, results.Projects[0].Summary.Pass)
 		assert.Equal(t, testTable.expectedWarningCount, results.Projects[0].Summary.WarningCount)
 		assert.Equal(t, testTable.expectedErrorCount, results.Projects[0].Summary.ErrorCount)
-		assert.Equal(t, fmt.Sprintf("Finished linting project. Results:\nWarning count: %v\nError count: %v\nRules passed: %v", testTable.expectedWarningCount, testTable.expectedErrorCount, testTable.expectedPass), results.ProjectSummaryText(lintedProject))
+		if testTable.expectedErrorCount == 0 && testTable.expectedWarningCount == 0 {
+			assert.Equal(t, "Linter results for project: no errors or warnings", results.ProjectSummaryText(lintedProject))
+		} else {
+			assert.Equal(t, fmt.Sprintf("Linter results for project: %v ERRORS, %v WARNINGS", testTable.expectedErrorCount, testTable.expectedWarningCount), results.ProjectSummaryText(lintedProject))
+		}
 	}
 }
 
@@ -290,7 +294,11 @@ func TestAddSummary(t *testing.T) {
 		assert.Equal(t, testTable.expectedPass, results.Passed())
 		assert.Equal(t, testTable.expectedWarningCount, results.Summary.WarningCount)
 		assert.Equal(t, testTable.expectedErrorCount, results.Summary.ErrorCount)
-		assert.Equal(t, fmt.Sprintf("Finished linting projects. Results:\nWarning count: %v\nError count: %v\nRules passed: %v", testTable.expectedWarningCount, testTable.expectedErrorCount, testTable.expectedPass), results.SummaryText())
+		if testTable.expectedErrorCount == 0 && testTable.expectedWarningCount == 0 {
+			assert.Equal(t, "Linter results for projects: no errors or warnings", results.SummaryText())
+		} else {
+			assert.Equal(t, fmt.Sprintf("Linter results for projects: %v ERRORS, %v WARNINGS", testTable.expectedErrorCount, testTable.expectedWarningCount), results.SummaryText())
+		}
 	}
 }
 

Original file line number	Diff line number	Diff line change
`@@ -207,7 +207,11 @@ func TestAddProjectSummary(t *testing.T) {`
`207`	`207`	`assert.Equal(t, testTable.expectedPass, results.Projects[0].Summary.Pass)`
`208`	`208`	`assert.Equal(t, testTable.expectedWarningCount, results.Projects[0].Summary.WarningCount)`
`209`	`209`	`assert.Equal(t, testTable.expectedErrorCount, results.Projects[0].Summary.ErrorCount)`
`210`		`- assert.Equal(t, fmt.Sprintf("Finished linting project. Results:\nWarning count: %v\nError count: %v\nRules passed: %v", testTable.expectedWarningCount, testTable.expectedErrorCount, testTable.expectedPass), results.ProjectSummaryText(lintedProject))`
	`210`	`+ if testTable.expectedErrorCount == 0 && testTable.expectedWarningCount == 0 {`
	`211`	`+ assert.Equal(t, "Linter results for project: no errors or warnings", results.ProjectSummaryText(lintedProject))`
	`212`	`+ } else {`
	`213`	`+ assert.Equal(t, fmt.Sprintf("Linter results for project: %v ERRORS, %v WARNINGS", testTable.expectedErrorCount, testTable.expectedWarningCount), results.ProjectSummaryText(lintedProject))`
	`214`	`+ }`
`211`	`215`	`}`
`212`	`216`	`}`
`213`	`217`
`@@ -290,7 +294,11 @@ func TestAddSummary(t *testing.T) {`
`290`	`294`	`assert.Equal(t, testTable.expectedPass, results.Passed())`
`291`	`295`	`assert.Equal(t, testTable.expectedWarningCount, results.Summary.WarningCount)`
`292`	`296`	`assert.Equal(t, testTable.expectedErrorCount, results.Summary.ErrorCount)`
`293`		`- assert.Equal(t, fmt.Sprintf("Finished linting projects. Results:\nWarning count: %v\nError count: %v\nRules passed: %v", testTable.expectedWarningCount, testTable.expectedErrorCount, testTable.expectedPass), results.SummaryText())`
	`297`	`+ if testTable.expectedErrorCount == 0 && testTable.expectedWarningCount == 0 {`
	`298`	`+ assert.Equal(t, "Linter results for projects: no errors or warnings", results.SummaryText())`
	`299`	`+ } else {`
	`300`	`+ assert.Equal(t, fmt.Sprintf("Linter results for projects: %v ERRORS, %v WARNINGS", testTable.expectedErrorCount, testTable.expectedWarningCount), results.SummaryText())`
	`301`	`+ }`
`294`	`302`	`}`
`295`	`303`	`}`
`296`	`304`