Expand description
Compatibility re-exports for CI output builders now owned by
fallow-output.
Structs§
- CiIssue
- Normalized CodeClimate issue used by CI comment renderers.
- Grouped
Review Issues - Review issues grouped per
(path, line)for one-comment-per-location rendering. - PrComment
Render Input - Inputs for rendering a sticky PR/MR summary comment.
- Review
Comment Render Input - Inputs for rendering one inline review comment from a location group.
- Review
Envelope Render Input - Inputs for rendering a GitHub/GitLab review envelope.
- Review
Envelope Render Result - Rendered review envelope plus side-channel signals for CLI telemetry.
- Review
Envelope Truncation - Truncation signals produced while rendering a review envelope.
- Review
Gitlab Diff Refs - GitLab diff refs for a review-envelope position.
Enums§
- CiProvider
- Supported CI review providers for generated comments.
Constants§
- MARKER_
PREFIX_ V2 - Marker prefix appended to every v2 review-comment body.
- MARKER_
SUFFIX_ V2 - Closing of the v2 marker, after the fingerprint string.
- MAX_
COMMENT_ BODY_ BYTES - Hard cap on a single review-comment body, matching GitHub’s 65 536-char comment limit; bodies at or over it are truncated with a marker suffix.
- PROJECT_
LEVEL_ RULE_ IDS - Rule ids whose findings describe project-wide config state rather than a change touching a specific source line.
Functions§
- cap_
body_ with_ marker - Append
marker_linetocontent, truncatingcontenton a char boundary so the whole body stays withinMAX_COMMENT_BODY_BYTES. The marker is never sacrificed. Returns the body and whether truncation happened. - command_
title - Human-readable report title for a fallow command name, e.g.
dupesmaps to “duplication report”. - composite_
fingerprint - Order-independent fingerprint for a comment merged from several findings:
constituents are sorted before hashing and the result carries a
merged:prefix. - escape_
md - Escape a string for inclusion in a Markdown table cell.
- github_
check_ conclusion - GitHub check conclusion for a set of findings:
Failurewhen any is major or above,Successwhen empty,Neutralotherwise. - group_
review_ issues_ by_ path_ line - Group consecutive same-(path, line) issues. Input is already sorted by
(path, line, fingerprint)so a single linear pass collects runs. - is_
project_ level_ rule - Whether findings for
rule_iddescribe the whole project (e.g. dependency rules) rather than a specific file location. - issues_
from_ codeclimate - Extract normalized CI issues from a raw CodeClimate JSON array, sorted by severity then location.
- issues_
from_ codeclimate_ issues - Normalize typed CodeClimate issues into CI issues, sorted by severity then location.
- render_
pr_ comment - Render the sticky PR/MR summary comment body: identity marker, headline count, and per-category findings tables.
- render_
review_ comment_ for_ group - Render one comment from a group of issues sharing the same
(path, line). - render_
review_ envelope - Render a provider-specific review envelope from typed CI issues.
- review_
label_ from_ codeclimate - Map a CodeClimate severity name to the review badge label:
errorfor major and above,warnotherwise. - summary_
fingerprint - Stable fingerprint for a summary comment body.
- summary_
label - Collapsible-section label for a findings category: appends “showing N” when the table is capped below the category’s total.