Skip to main content

Module cli_output

Module cli_output 

Source
Expand description

CLI output functions for job-focused commands

Provides specialized output formats for different JTBD (Jobs to be Done):

  • Hotspots: Quick identification of refactoring priorities
  • Impact: Change impact analysis for a specific module
  • Check: CI/CD quality gate with exit codes
  • JSON: Machine-readable output for automation

Structs§

CascadingImpact
Cascading impact analysis
CheckConfig
Quality check configuration
CheckResult
Check result with details
DependencyInfo
Information about a dependency relationship (grouped by module)
Hotspot
A hotspot module that needs attention
HotspotIssue
An issue contributing to a hotspot
ImpactAnalysis
Impact analysis result for a module
IssueExplanation
Beginner-friendly explanation for an issue
JsonAnalysisManifest
Declared analysis blind spots in JSON format
JsonBaselineDiff
Baseline diff in JSON format.
JsonBlindSpot
Structural blind spot in JSON format
JsonExternalDependencies
External dependency analysis in JSON format.
JsonExternalDependenciesOutput
Standalone external-dependency JSON output.
JsonGradeChange
Baseline/current grade transition in JSON format.
JsonGradeRationale
Health-grade rationale in JSON format.
JsonHistory
Complete history timeline in JSON format.
JsonHistoryPoint
A single timeline point in JSON format.
JsonIssue
Issue in JSON format
JsonIssueTypeContribution
Issue-type contribution in JSON format.
JsonModule
Module in JSON format
JsonOutput
Complete analysis in JSON format
JsonSkippedRevision
A skipped revision in JSON format.
JsonSummary
Summary in JSON format
JsonTemporalCoupling
Temporal coupling in JSON format
StrengthCount
Count of couplings by strength type
TraceDependency
A traced dependency
TraceResult
Trace result for a specific item (function/type)

Functions§

analyze_impact
Analyze impact of changing a specific module
calculate_hotspots
Calculate hotspots from project metrics
generate_baseline_diff_output
Generate a readable baseline diff report.
generate_check_output
Generate check output and return exit code (0 = pass, 1 = fail)
generate_external_dependencies_output
Render external dependency coupling as text or JSON.
generate_history_output
Render a history report as text or JSON.
generate_hotspots_output
Generate hotspots output to writer
generate_impact_output
Generate impact analysis output
generate_json_output
Generate complete JSON output
generate_json_output_with_diff
Generate complete JSON output with a top-level baseline diff object.
generate_ratchet_check_output
Generate ratchet gate output and return exit code (0 = pass, 1 = fail).
generate_trace_output
Generate trace output for a specific function/type
get_issue_explanation
Get a beginner-friendly explanation for an issue type
history_report_to_json
Convert a history report into its shared JSON representation.
parse_grade
Parse grade string to HealthGrade
parse_severity
Parse severity string to Severity
run_check
Run quality check and return result