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§
- Cascading
Impact - Cascading impact analysis
- Check
Config - Quality check configuration
- Check
Result - Check result with details
- Dependency
Info - Information about a dependency relationship (grouped by module)
- Hotspot
- A hotspot module that needs attention
- Hotspot
Issue - An issue contributing to a hotspot
- Impact
Analysis - Impact analysis result for a module
- Issue
Explanation - Beginner-friendly explanation for an issue
- Json
Analysis Manifest - Declared analysis blind spots in JSON format
- Json
Baseline Diff - Baseline diff in JSON format.
- Json
Blind Spot - Structural blind spot in JSON format
- Json
External Dependencies - External dependency analysis in JSON format.
- Json
External Dependencies Output - Standalone external-dependency JSON output.
- Json
Grade Change - Baseline/current grade transition in JSON format.
- Json
Grade Rationale - Health-grade rationale in JSON format.
- Json
History - Complete history timeline in JSON format.
- Json
History Point - A single timeline point in JSON format.
- Json
Issue - Issue in JSON format
- Json
Issue Type Contribution - Issue-type contribution in JSON format.
- Json
Module - Module in JSON format
- Json
Output - Complete analysis in JSON format
- Json
Skipped Revision - A skipped revision in JSON format.
- Json
Summary - Summary in JSON format
- Json
Temporal Coupling - Temporal coupling in JSON format
- Strength
Count - Count of couplings by strength type
- Trace
Dependency - A traced dependency
- Trace
Result - 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