render

Documentation

Index

• func New(kind string, w io.Writer) (malcontent.Renderer, error)
• func ShortRisk(s string) string
• func Statistics(r *malcontent.Report) error
• type JSON
  • func NewJSON(w io.Writer) JSON
  • func (r JSON) File(_ context.Context, _ *malcontent.FileReport) error
  • func (r JSON) Full(_ context.Context, rep *malcontent.Report) error
  • func (r JSON) Scanning(_ context.Context, _ string)
• type KeyedBehavior
• type Markdown
  • func NewMarkdown(w io.Writer) Markdown
  • func (r Markdown) File(ctx context.Context, fr *malcontent.FileReport) error
  • func (r Markdown) Full(ctx context.Context, rep *malcontent.Report) error
  • func (r Markdown) Scanning(_ context.Context, _ string)
• type Match
• type Report
• type Simple
  • func NewSimple(w io.Writer) Simple
  • func (r Simple) File(_ context.Context, fr *malcontent.FileReport) error
  • func (r Simple) Full(_ context.Context, rep *malcontent.Report) error
  • func (r Simple) Scanning(_ context.Context, _ string)
• type StringMatches
  • func NewStringMatches(w io.Writer) StringMatches
  • func (r StringMatches) File(_ context.Context, fr *malcontent.FileReport) error
  • func (r StringMatches) Full(_ context.Context, rep *malcontent.Report) error
  • func (r StringMatches) Scanning(_ context.Context, path string)
• type Terminal
  • func NewTerminal(w io.Writer) Terminal
  • func (r Terminal) File(ctx context.Context, fr *malcontent.FileReport) error
  • func (r Terminal) Full(ctx context.Context, rep *malcontent.Report) error
  • func (r Terminal) Scanning(_ context.Context, path string)
• type TerminalBrief
  • func NewTerminalBrief(w io.Writer) TerminalBrief
  • func (r TerminalBrief) File(_ context.Context, fr *malcontent.FileReport) error
  • func (r TerminalBrief) Full(_ context.Context, rep *malcontent.Report) error
  • func (r TerminalBrief) Scanning(_ context.Context, path string)
• type YAML
  • func NewYAML(w io.Writer) YAML
  • func (r YAML) File(_ context.Context, _ *malcontent.FileReport) error
  • func (r YAML) Full(_ context.Context, rep *malcontent.Report) error
  • func (r YAML) Scanning(_ context.Context, _ string)

Functions

func New

func New(kind string, w io.Writer) (malcontent.Renderer, error)

New returns a new Renderer.

func ShortRisk

func ShortRisk(s string) string

func Statistics

func Statistics(r *malcontent.Report) error

Types

type JSON

type JSON struct {
	// contains filtered or unexported fields
}

func NewJSON

func NewJSON(w io.Writer) JSON

func (JSON) File

func (r JSON) File(_ context.Context, _ *malcontent.FileReport) error

func (JSON) Full

func (r JSON) Full(_ context.Context, rep *malcontent.Report) error

func (JSON) Scanning

func (r JSON) Scanning(_ context.Context, _ string)

type KeyedBehavior

type KeyedBehavior struct {
	Key      string
	Behavior *malcontent.Behavior
}

type Markdown

type Markdown struct {
	// contains filtered or unexported fields
}

func NewMarkdown

func NewMarkdown(w io.Writer) Markdown

func (Markdown) File

func (r Markdown) File(ctx context.Context, fr *malcontent.FileReport) error

func (Markdown) Full

func (r Markdown) Full(ctx context.Context, rep *malcontent.Report) error

func (Markdown) Scanning

func (r Markdown) Scanning(_ context.Context, _ string)

type Match

type Match struct {
	Description string
	Risk        int
	Rule        string
	Strings     []string
}

type Report

type Report struct {
	Diff   *malcontent.DiffReport            `json:",omitempty" yaml:",omitempty"`
	Files  map[string]*malcontent.FileReport `json:",omitempty" yaml:",omitempty"`
	Filter string                            `json:",omitempty" yaml:",omitempty"`
}

Report stores a JSON- or YAML-friendly representation of File Reports.

type Simple

type Simple struct {
	// contains filtered or unexported fields
}

func NewSimple

func NewSimple(w io.Writer) Simple

func (Simple) File

func (r Simple) File(_ context.Context, fr *malcontent.FileReport) error

func (Simple) Full

func (r Simple) Full(_ context.Context, rep *malcontent.Report) error

func (Simple) Scanning

func (r Simple) Scanning(_ context.Context, _ string)

type StringMatches

type StringMatches struct {
	// contains filtered or unexported fields
}

func NewStringMatches

func NewStringMatches(w io.Writer) StringMatches

func (StringMatches) File

func (r StringMatches) File(_ context.Context, fr *malcontent.FileReport) error

func (StringMatches) Full

func (r StringMatches) Full(_ context.Context, rep *malcontent.Report) error

func (StringMatches) Scanning

func (r StringMatches) Scanning(_ context.Context, path string)

type Terminal

type Terminal struct {
	// contains filtered or unexported fields
}

func NewTerminal

func NewTerminal(w io.Writer) Terminal

func (Terminal) File

func (r Terminal) File(ctx context.Context, fr *malcontent.FileReport) error

func (Terminal) Full

func (r Terminal) Full(ctx context.Context, rep *malcontent.Report) error

func (Terminal) Scanning

func (r Terminal) Scanning(_ context.Context, path string)

type TerminalBrief

type TerminalBrief struct {
	// contains filtered or unexported fields
}

func NewTerminalBrief

func NewTerminalBrief(w io.Writer) TerminalBrief

func (TerminalBrief) File

func (r TerminalBrief) File(_ context.Context, fr *malcontent.FileReport) error

func (TerminalBrief) Full

func (r TerminalBrief) Full(_ context.Context, rep *malcontent.Report) error

func (TerminalBrief) Scanning

func (r TerminalBrief) Scanning(_ context.Context, path string)

type YAML

type YAML struct {
	// contains filtered or unexported fields
}

func NewYAML

func NewYAML(w io.Writer) YAML

func (YAML) File

func (r YAML) File(_ context.Context, _ *malcontent.FileReport) error

func (YAML) Full

func (r YAML) Full(_ context.Context, rep *malcontent.Report) error

func (YAML) Scanning

func (r YAML) Scanning(_ context.Context, _ string)