Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve legibility of terminal diff output #670

Merged
merged 5 commits into from
Dec 1, 2024
Merged

Improve legibility of terminal diff output #670

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c76d7fb
Make diff output clearer
tstromberg Nov 30, 2024
f26df47
fix indentation
tstromberg Nov 30, 2024
b008216
remove newline
tstromberg Nov 30, 2024
8d52952
Merge branch 'main' into fixdiff
tstromberg Nov 30, 2024
6927c6d
Merge branch 'main' into fixdiff
egibs Dec 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 21 additions & 16 deletions pkg/render/terminal.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,27 +269,33 @@ func renderFileSummary(_ context.Context, fr *malcontent.FileReport, w io.Writer
riskScore := nsRiskScore[ns]
riskLevel := riskLevels[riskScore]
nsIcon := "≡"
indent := " "
indent := " "
diff := " "

// namespace readout
if len(previousNsRiskScore) > 0 && riskScore != previousNsRiskScore[ns] {
previousRiskLevel := riskLevels[previousNsRiskScore[ns]]
if previousRiskLevel == "NONE" {
diff = color.HiGreenString("+")
}

if riskLevel < previousRiskLevel {
nsIcon = color.HiYellowString("▲")
}
if riskLevel > previousRiskLevel {
nsIcon = color.HiGreenString("▼")
}
if riskLevel == "NONE" {
nsIcon = color.RedString("X")
diff = color.HiRedString("-")
}

fmt.Fprintf(w, "│%s%s %s %s\n", indent, nsIcon, nsLongName(ns), darkBrackets(fmt.Sprintf("%s → %s", riskInColor(previousRiskLevel), riskInColor(riskLevel))))
fmt.Fprintf(w, "│%s%s%s %s %s\n", diff, indent, nsIcon, nsLongName(ns), darkBrackets(fmt.Sprintf("%s → %s", riskInColor(previousRiskLevel), riskInColor(riskLevel))))
} else {
fmt.Fprintf(w, "│%s%s %s %s\n", indent, nsIcon, nsLongName(ns), darkBrackets(riskInColor(riskLevel)))
fmt.Fprintf(w, "│%s%s%s %s %s\n", diff, indent, nsIcon, nsLongName(ns), darkBrackets(riskInColor(riskLevel)))
}

// behavior readout per namespace
indent += " "
for _, b := range bs {
_, rest := splitRuleID(b.ID)

Expand All @@ -305,48 +311,47 @@ func renderFileSummary(_ context.Context, fr *malcontent.FileReport, w io.Writer
}
}

prefix := "│ "
bullet := riskEmoji(b.RiskScore)
content := fmt.Sprintf("%s%s%s %s", prefix, indent, riskColor(b.RiskLevel, bullet+" "+rest), desc)
diff := " "
content := fmt.Sprintf("%s%s%s %s", diff, indent, riskColor(b.RiskLevel, bullet+" "+rest), desc)
pc := color.New()

if diffMode {
content = fmt.Sprintf("%s%s%s %s %s", prefix, indent, bullet, rest, desc)

if b.DiffAdded {
pc = color.New(color.FgHiGreen)
prefix = "+++"
content = fmt.Sprintf("%s%s%s %s %s", prefix, indent, bullet, rest, desc)
diff = "+"
}

if b.DiffRemoved {
prefix = "---"
diff = "-"
pc = color.New(color.FgHiRed)
content = fmt.Sprintf("%s%s%s %s %s", prefix, indent, bullet, rest, desc)
e = ""
}

if !b.DiffAdded && !b.DiffRemoved {
prefix = " "
pc = color.New(color.FgHiCyan)
content = fmt.Sprintf("%s%s%s %s %s", prefix, indent, bullet, rest, desc)
e = ""
}

content = fmt.Sprintf("%s%s%s %s %s", diff, indent, bullet, rest, desc)
}

prefix := "│"
// no evidence to give
if e == "" {
pc.Fprintln(w, content+e)
fmt.Fprint(w, prefix)
pc.Fprintln(w, content)
continue
}

fmt.Fprint(w, prefix)
pc.Fprint(w, content)
color.New(color.FgHiBlack).Fprint(w, ":")
e = color.RGB(255, 255, 255).Sprint(e)

// Two-line output for long evidence strings
if ansiLineLength(content+e)+1 > width && len(e) > 4 {
pc.Fprintln(w, "\n"+truncate(fmt.Sprintf("%s %s", prefix, e), width))
pc.Fprintln(w, "\n"+truncate(fmt.Sprintf("%s%s %s", prefix, diff, e), width))
continue
}
// Single-line output for short evidence
Expand Down