#report()

Structured reporting middleware. Decorates ctx.report with methods for writing checks, findings, and summaries.

Import from maltty/report.

#report(options?)

Create the report middleware.

#createReport(options?)

Create a standalone Report instance outside the middleware pipeline.

#Report

The ctx.report interface:

#CheckInput

#FindingInput

#CodeFrameInput

#CodeFrameAnnotation

#SummaryInput

Discriminated union on style:

#Block style ('tally')

#Inline style

#SummaryStat

#ReportEnv

Middleware environment descriptor. Declares that ctx.report will be available after this middleware runs.

#Module augmentation

import type { Report } from 'maltty/report'

declare module 'maltty' {
  interface CommandContext {
    readonly report: Report
  }
}

#References

• Reporting
• Core