lint/rpt: Handle no-color ttys (#1213)

This fixes #1211 by supporting the NO_COLOR environment variable and checking if the output is a tty before using color. The color.NoColor global is used as described here: https://github.com/fatih/color?tab=readme-ov-file#disableenable-color Signed-off-by: Charlie Egan <[email protected]>
StyraInc · Oct 21, 2024 · 234e36b · 234e36b
1 parent 63b90e1
commit 234e36b
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 0 deletions.
diff --git a/pkg/reporter/reporter.go b/pkg/reporter/reporter.go
@@ -238,6 +238,13 @@ func buildPrettyViolationsTable(violations []report.Violation) string {
 		}
 
 		table.Append([]string{yellow("Rule:"), violation.Title})
+
+		// if there is no support for color, then we show the level in addition
+		// so that the level of the violation is still clear
+		if color.NoColor {
+			table.Append([]string{"Level:", violation.Level})
+		}
+
 		table.Append([]string{yellow("Description:"), description})
 		table.Append([]string{yellow("Category:"), violation.Category})
 		// End location ignored here as it's not too interesting in this format and line:column

diff --git a/pkg/reporter/testdata/pretty/reporter-long-text.txt b/pkg/reporter/testdata/pretty/reporter-long-text.txt
@@ -1,4 +1,5 @@
 Rule:         	long-violation                                                                                                          	
+Level:        	warning                                                                                                                 	
 Description:  	violation with a long description                                                                                       	
 Category:     	long                                                                                                                    	
 Location:     	b.rego:22:18                                                                                                            	

diff --git a/pkg/reporter/testdata/pretty/reporter.txt b/pkg/reporter/testdata/pretty/reporter.txt
@@ -1,11 +1,13 @@
 Rule:         	breaking-the-law                	
+Level:        	error                           	
 Description:  	Rego must not break the law!    	
 Category:     	legal                           	
 Location:     	a.rego:1:1                      	
 Text:         	package illegal                 	
 Documentation:	https://example.com/illegal     	
 
 Rule:         	questionable-decision           	
+Level:        	warning                         	
 Description:  	Questionable decision found     	
 Category:     	really?                         	
 Location:     	b.rego:22:18