format

Documentation

Index

• func AsJSON(r *pkg.ScorecardResult, showDetails bool, logLevel log.Level, writer io.Writer) error
• func AsJSON2(r *pkg.ScorecardResult, showDetails bool, logLevel log.Level, ...) error
• func AsRawJSON(r *pkg.ScorecardResult, writer io.Writer) error
• func GenerateBQSchema(t interface{}) (string, error)
• func GenerateJSONSchema(t interface{}) string

Functions

func AsJSON

func AsJSON(r *pkg.ScorecardResult, showDetails bool, logLevel log.Level, writer io.Writer) error

AsJSON exports results as JSON for new detail format.

func AsJSON2

func AsJSON2(r *pkg.ScorecardResult, showDetails bool,
	logLevel log.Level, checkDocs docs.Doc, writer io.Writer,
) error

AsJSON2 exports results as JSON for the cron job and in the new detail format.

func AsRawJSON

func AsRawJSON(r *pkg.ScorecardResult, writer io.Writer) error

AsRawJSON exports results as JSON for raw results.

func GenerateBQSchema

func GenerateBQSchema(t interface{}) (string, error)

GenerateBQSchema generates the BQ schema in JSON format. Can be used to generate a BQ table: `bq mk --table --time_partitioning_type DAY \ --require_partition_filter=TRUE \ --time_partitioning_field date \ openssf:scorecardcron.scorecard-rawdata-releasetest \ cron/format/bq.raw.schema`. The structure `t` must be annotated using BQ fields: a string `bigquery:"name"`.

func GenerateJSONSchema

func GenerateJSONSchema(t interface{}) string

GenerateJSONSchema generates the schema for a JSON structure.