design_fidelity_ledger.hpp

Go to the documentation of this file.

#pragma once
 
// Named fidelity taxonomy + per-run ledger.
//
// design_fidelity.hpp computes FidelityIssue findings (skew, dropped-vector, …)
// during codegen. This is the reporting layer on top of them:
//
//   - a NAMED taxonomy: every fidelity kind the checks can emit, each with a
//     stable slug, a default severity, and a one-line description. Tooling and
//     humans get a documented contract instead of ad-hoc `kind` strings.
//   - a per-run LEDGER: a deterministic JSON report of one import's findings
//     with per-kind counts, so an import's fidelity is a durable, diffable
//     artifact rather than transient stderr lines. Warnings are data, not
//     failures — the ledger records everything and lets the consumer decide.
//
// Kept separate from design_fidelity.cpp so the pure checks stay free of JSON
// and reporting concerns.
 
#include <pulp/view/design_fidelity.hpp>  // FidelityIssue
 
#include <string>
#include <string_view>
#include <vector>
 
namespace pulp::view {

inline constexpr std::string_view kFidelityLedgerVersion = "2026.07-fidelity-ledger-v1";

struct FidelityKindInfo {
    std::string kind;      
    std::string severity;  
    std::string summary;   
};

const std::vector<FidelityKindInfo>& fidelity_taxonomy();

const FidelityKindInfo* fidelity_kind_info(const std::string& kind);

struct FidelityLedgerMeta {
    std::string source;        
    std::string output;        
    std::string generated_at;  
};

std::string fidelity_ledger_json(const std::vector<FidelityIssue>& issues,
                                 const FidelityLedgerMeta& meta);
 
}  // namespace pulp::view