@blast-shield/display

Terminal rendering for blast-shield debt analysis results.

Part of the blast-shield monorepo.

Purpose

Renders technical debt analysis output to the terminal. Provides two renderers:

• renderDebtResults — formats per-file debt findings as a structured list
• renderDebtSummary — renders an aggregate summary box with debt counts, severity level, and a conclusion message

Installation

This package is an internal monorepo package — it is not published to npm separately. It is consumed by apps/cli.

API

renderDebtResults(results, options?)

Renders per-file debt results to the terminal via the internal logger.

import { renderDebtResults } from '@blast-shield/display';

renderDebtResults(debtResults);

| Parameter | Type | Description | |-----------|------|-------------| | results | DebtResult[] | Array of per-file debt findings from @blast-shield/core | | options | object (optional) | Rendering options |

renderDebtSummary(counts, options?)

Renders an aggregate debt summary box with severity level and conclusion message.

import { renderDebtSummary } from '@blast-shield/display';

renderDebtSummary(debtCounts);

| Parameter | Type | Description | |-----------|------|-------------| | counts | DebtCounts | Aggregate debt counts from @blast-shield/core | | options | object (optional) | Rendering options |

Dependencies

| Package | Purpose | |---------|---------| | @blast-shield/core | Types and severity logic | | @blast-shield/logger | Terminal output via signale | | boxen | Summary box rendering | | nanocolors | Terminal colour formatting |

Development

pnpm build       # Build the package
pnpm test        # Run tests
pnpm lint        # Run Biome linter