json

package
v1.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 19, 2026 License: MIT Imports: 4 Imported by: 0

Documentation

Overview

Package json provides a JSON output formatter.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Formatter

type Formatter struct {
	// ShowRaw controls whether the raw secret value is included in output.
	// finding.Finding.Raw carries a json:"-" tag, so it is never serialized by
	// default. When ShowRaw is true, each finding is marshaled through the
	// findingJSON wire type below to explicitly opt the value back in.
	ShowRaw bool
}

Formatter outputs findings in JSON format.

func (*Formatter) FileExtension

func (f *Formatter) FileExtension() string

FileExtension returns the JSON file extension.

func (*Formatter) Format

func (f *Formatter) Format(w io.Writer, findings []finding.Finding) error

Format writes findings as JSON to the given writer. When ShowRaw is false, finding.Finding is marshaled directly and both the raw secret and ExtraData are omitted by their json:"-" tags. When ShowRaw is true, each finding is marshaled via findingJSON so the raw value and any non-secret ExtraData are explicitly included.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL