Structs§
- CiIssue
- Normalized CodeClimate issue used by CI comment renderers.
- Code
Climate Issue - Single CodeClimate-compatible issue inside
CodeClimateOutput. - PrComment
Envelope - Rendered PR comment body plus posting signals for provider adapters.
- PrComment
Truncation - Finding-count truncation metadata for a rendered PR comment.
- PrDecision
Annotation - File-anchored annotation inside
PrDecisionSurface::annotations. - PrDecision
Details - Report content and links inside
PrDecisionSurface::details. - PrDecision
Gate - One quality-gate outcome inside
PrDecisionSurface::gates. - PrDecision
Surface - Provider-neutral PR gate decision, consumed by CI integrations to publish a check run or equivalent status surface.
- PrDetails
Artifact - Full-findings report artifact backing the PR summary comment’s details link, grouped into per-area sections.
- PrDetails
Row - One finding row inside
PrDetailsSection::rows. - PrDetails
Section - One findings section inside
PrDetailsArtifact::sections.
Enums§
- PrComment
Layout - Body layout variant for the sticky PR comment.
- PrDecision
Annotation Level - Display level for a
PrDecisionAnnotation; values mirror GitHub check-run annotation levels. - PrDecision
Conclusion - Outcome of the overall decision or a single gate; values mirror GitHub check-run conclusions.
- Provider
- Supported CI review providers for generated comments.
Constants§
- PR_
DECISION_ SCHEMA - Schema discriminator serialized into
PrDecisionSurface::schema. - PR_
DETAILS_ SCHEMA - Schema discriminator serialized into
PrDetailsArtifact::schema.
Functions§
- command_
title - Human-readable report title for a fallow command name, e.g.
dupesmaps to “duplication report”. - issues_
from_ codeclimate - Extract normalized CI issues from a raw CodeClimate JSON array, sorted by severity then location.
- render_
pr_ comment - Render the sticky comment body.
conclusionis the gate outcome the caller already computed, folded into the severity-derived verdict by the renderer;Nonerenders the severity-derived verdict alone. - set_
workspace_ marker_ from_ list - Set the workspace marker from a
--workspaceselection list.