This documentation is also published as Markdown for efficient machine reading: the whole site is indexed at /llms.txt, and every page has a clean Markdown copy at the same URL with .md appended. These are generated from the same source and cost far fewer tokens to read than this rendered HTML.

Skip to main content Skip to navigation

BuildReport Pennington.Generation

Aggregated result of a static build run, including diagnostics and per-page outcomes.

Properties

Diagnostics ImmutableList<BuildDiagnostic>
Diagnostics recorded during the build.
Duration TimeSpan
Total wall-clock duration of the build.
FailedPages ImmutableList<ContentRoute>
Routes whose generation failed.
GeneratedPages ImmutableList<ContentRoute>
Routes that were successfully written to the output directory.
HasErrors bool
True when the build produced any error diagnostics, broken links, or failed pages.
SkippedPages ImmutableList<ContentRoute>
Routes that were skipped (typically drafts).
TotalPages int
Total number of pages considered, including generated, skipped, and failed.

Constructors

BuildReport

#
public BuildReport(ImmutableList<BuildDiagnostic> diagnostics, ImmutableList<ContentRoute> generatedPages, ImmutableList<ContentRoute> skippedPages, ImmutableList<ContentRoute> failedPages, TimeSpan duration)

Initializes a completed build report with all captured results.

Parameters

diagnostics ImmutableList<BuildDiagnostic>
generatedPages ImmutableList<ContentRoute>
skippedPages ImmutableList<ContentRoute>
failedPages ImmutableList<ContentRoute>
duration TimeSpan

Methods

ToFormattedString

#
public string ToFormattedString()

Returns the human-readable summary as a single formatted string.

Returns

string

WriteTo

#
public void WriteTo(TextWriter writer)

Writes a human-readable summary of the report to writer.

Parameters

writer TextWriter

Pennington.Generation.BuildReport

namespace Pennington.Generation;

/// Aggregated result of a static build run, including diagnostics and per-page outcomes.
public class BuildReport
{
    /// Initializes a completed build report with all captured results.
    
public BuildReport(ImmutableList<BuildDiagnostic> diagnostics, ImmutableList<ContentRoute> generatedPages, ImmutableList<ContentRoute> skippedPages, ImmutableList<ContentRoute> failedPages, TimeSpan duration)
; /// Diagnostics recorded during the build.
public ImmutableList<BuildDiagnostic> Diagnostics { get; }
/// Total wall-clock duration of the build.
public TimeSpan Duration { get; }
/// Routes whose generation failed.
public ImmutableList<ContentRoute> FailedPages { get; }
/// Routes that were successfully written to the output directory.
public ImmutableList<ContentRoute> GeneratedPages { get; }
/// True when the build produced any error diagnostics, broken links, or failed pages.
public bool HasErrors { get; }
/// Routes that were skipped (typically drafts).
public ImmutableList<ContentRoute> SkippedPages { get; }
/// Returns the human-readable summary as a single formatted string.
public string ToFormattedString()
; /// Total number of pages considered, including generated, skipped, and failed.
public int TotalPages { get; }
/// Writes a human-readable summary of the report to writer.
public void WriteTo(TextWriter writer)
; }