Method AsString

pkg/scorecard/scorecard_result.go:192–275

AsString returns ScorecardResult in string format.

(writer io.Writer, checkDocs docChecks.Doc, opt *AsStringResultOption)

// AsString returns ScorecardResult in string format.
func (r *Result) AsString(writer io.Writer, checkDocs docChecks.Doc, opt *AsStringResultOption) error {
	if opt == nil {
		opt = &AsStringResultOption{
			LogLevel:    log.DefaultLevel,
			Details:     false,
			Annotations: false,
		}
	}

	data := make([][]string, len(r.Checks))

	for i, row := range r.Checks {
		var x []string

		// UPGRADEv2: rename variable.
		if row.Score == checker.InconclusiveResultScore {
			x = append(x, "?")
		} else {
			x = append(x, fmt.Sprintf("%d / %d", row.Score, checker.MaxResultScore))
		}

		cdoc, e := checkDocs.GetCheck(row.Name)
		if e != nil {
			return sce.WithMessage(sce.ErrScorecardInternal, fmt.Sprintf("GetCheck: %s: %v", row.Name, e))
		}

		doc := cdoc.GetDocumentationURL(r.Scorecard.CommitSHA)
		x = append(x, row.Name, row.Reason)
		if opt.Details {
			details, show := detailsToString(row.Details, opt.LogLevel)
			if show {
				x = append(x, details)
			}
		}
		x = append(x, doc)
		if opt.Annotations {
			reasons := row.Annotations(r.Config)
			x = append(x, strings.Join(reasons, "\n"))
		}
		data[i] = x
	}

	score, err := r.GetAggregateScore(checkDocs)
	if err != nil {
		return err
	}
	s := fmt.Sprintf("Aggregate score: %s / %d\n\n", scoreToString(score), checker.MaxResultScore)
	if score == checker.InconclusiveResultScore {
		s = "Aggregate score: ?\n\n"
	}
	fmt.Fprint(writer, s)
	fmt.Fprintln(writer, "Check scores:")

	cfg := tablewriter.Config{
		Row: tw.CellConfig{
			Alignment: tw.CellAlignment{Global: tw.AlignLeft},
		},
	}