note

Documentation

Overview

Package note renders a module's Note for the terminal or as JSON.

Index

• func JSON(n module.Note) string
• func Sanitize(s string) string
• func Text(n module.Note) string
• func TextVerbose(n module.Note) string

Functions

func JSON

func JSON(n module.Note) string

JSON renders a Note as a JSON object.

func Sanitize

func Sanitize(s string) string

Sanitize neutralizes control/ANSI sequences and caps length on any string that may originate from untrusted input (a hostile API response or a malicious variable name), so it can't hijack the terminal. Exported for callers that print note-derived text outside Text/JSON (e.g. the summary).

func Text

func Text(n module.Note) string

Text renders a Note as the short human-readable block (summarized: a finding's Detail expansion is omitted).

func TextVerbose

func TextVerbose(n module.Note) string

TextVerbose renders a Note and expands each finding's Detail (e.g. the full list of files a secret was also found in) as indented lines beneath it.