report

package

v1.0.4 Latest Latest Go to latest Published: Jul 12, 2025 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/Voskan/codexsentinel

Links

Open Source Insights

Documentation ¶

Overview ¶

Package report provides functionality to generate various types of reports.

Index ¶

func GenerateReport(issues []Issue, format, outPath string) error
type Issue
type ReportData
type SeverityLevel
type Summary

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func GenerateReport ¶

func GenerateReport(issues []Issue, format, outPath string) error

GenerateReport creates a report in the specified format (json, html).

Types ¶

type Issue ¶

type Issue struct {
	RuleID      string        `json:"rule_id"`
	Title       string        `json:"title"`
	Description string        `json:"description"`
	Severity    SeverityLevel `json:"severity"`
	File        string        `json:"file"`
	Line        int           `json:"line"`
	Code        string        `json:"code"`
	Package     string        `json:"package"`
	Reference   string        `json:"reference,omitempty"`
	Suggestion  string        `json:"suggestion,omitempty"`
}

Issue represents a single security/code issue found during analysis.

type ReportData ¶

type ReportData struct {
	Summary     Summary `json:"summary"`
	Issues      []Issue `json:"issues"`
	GeneratedAt string  `json:"generated_at"`
}

ReportData represents the full report structure.

type SeverityLevel ¶

type SeverityLevel string

SeverityLevel defines the level of issue severity.

const (
	SeverityCritical SeverityLevel = "CRITICAL"
	SeverityHigh     SeverityLevel = "HIGH"
	SeverityMedium   SeverityLevel = "MEDIUM"
	SeverityLow      SeverityLevel = "LOW"
	SeverityInfo     SeverityLevel = "INFO"
)

type Summary ¶

type Summary struct {
	Total    int `json:"total"`
	Critical int `json:"critical"`
	High     int `json:"high"`
	Medium   int `json:"medium"`
	Low      int `json:"low"`
	Info     int `json:"info"`
}

Summary aggregates issue counts per severity level.

Source Files ¶

View all Source files

generator.go

Directories ¶

Path	Synopsis
formats
template

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