Documentation
¶
Overview ¶
Package outwriter has output and writer logic.
Index ¶
- func WriteComparisonResults(w io.Writer, comparisonResult schema.ComparisonResult, cfg *contract.Config, ...) error
- func WriteFileResults(w io.Writer, files []schema.FileResult, cfg *contract.Config, ...) error
- func WriteFolderResults(w io.Writer, results []schema.FolderResult, cfg *contract.Config, ...) error
- func WriteMetricsDefinitions(w io.Writer, ...) error
- func WriteTimeseriesResults(w io.Writer, result schema.TimeseriesResult, cfg *contract.Config, ...) error
- func WriteWithOutputFile(cfg *contract.Config, writer func(io.Writer) error, successMsg string) error
- type OutWriter
- func (ow *OutWriter) WriteComparison(w io.Writer, results schema.ComparisonResult, cfg *contract.Config, ...) error
- func (ow *OutWriter) WriteFiles(w io.Writer, results []schema.FileResult, cfg *contract.Config, ...) error
- func (ow *OutWriter) WriteFolders(w io.Writer, results []schema.FolderResult, cfg *contract.Config, ...) error
- func (ow *OutWriter) WriteMetrics(w io.Writer, ...) error
- func (ow *OutWriter) WriteTimeseries(w io.Writer, result schema.TimeseriesResult, cfg *contract.Config, ...) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func WriteComparisonResults ¶
func WriteComparisonResults(w io.Writer, comparisonResult schema.ComparisonResult, cfg *contract.Config, duration time.Duration) error
WriteComparisonResults outputs the analysis results, dispatching based on the output format configured.
func WriteFileResults ¶
func WriteFileResults(w io.Writer, files []schema.FileResult, cfg *contract.Config, duration time.Duration) error
WriteFileResults outputs the analysis results, dispatching based on the output format configured.
func WriteFolderResults ¶
func WriteFolderResults(w io.Writer, results []schema.FolderResult, cfg *contract.Config, duration time.Duration) error
WriteFolderResults outputs the analysis results, dispatching based on the output format configured.
func WriteMetricsDefinitions ¶
func WriteMetricsDefinitions(w io.Writer, activeWeights map[schema.ScoringMode]map[schema.BreakdownKey]float64, cfg *contract.Config) error
WriteMetricsDefinitions displays the formal definitions of all scoring modes. This is a static display that does not require Git analysis.
func WriteTimeseriesResults ¶
func WriteTimeseriesResults(w io.Writer, result schema.TimeseriesResult, cfg *contract.Config, duration time.Duration) error
WriteTimeseriesResults outputs the timeseries results, dispatching based on the output format configured.
func WriteWithOutputFile ¶ added in v1.5.1
func WriteWithOutputFile(cfg *contract.Config, writer func(io.Writer) error, successMsg string) error
WriteWithOutputFile handles the common pattern of opening a file, writing to it, and cleaning up. It accepts a writer function that takes an io.Writer and returns an error.
Types ¶
type OutWriter ¶
type OutWriter struct{}
OutWriter provides a unified interface for all output operations. It encapsulates the various output formats and provides a clean API for the core logic.
func NewOutWriter ¶
func NewOutWriter() *OutWriter
NewOutWriter creates a new instance of the output writer.
func (*OutWriter) WriteComparison ¶
func (ow *OutWriter) WriteComparison(w io.Writer, results schema.ComparisonResult, cfg *contract.Config, duration time.Duration) error
WriteComparison writes comparison analysis results using the configured output format.
func (*OutWriter) WriteFiles ¶
func (ow *OutWriter) WriteFiles(w io.Writer, results []schema.FileResult, cfg *contract.Config, duration time.Duration) error
WriteFiles writes file analysis results using the configured output format.
func (*OutWriter) WriteFolders ¶
func (ow *OutWriter) WriteFolders(w io.Writer, results []schema.FolderResult, cfg *contract.Config, duration time.Duration) error
WriteFolders writes folder analysis results using the configured output format.
func (*OutWriter) WriteMetrics ¶
func (ow *OutWriter) WriteMetrics(w io.Writer, activeWeights map[schema.ScoringMode]map[schema.BreakdownKey]float64, cfg *contract.Config) error
WriteMetrics writes metrics definitions using the configured output format.
Source Files