Function logReport

packages/plugin-jsdocs/src/lib/runner/utils.ts:97–126

(report: Record<CoverageType, FileCoverage[]>)

}

export function logReport(report: Record<CoverageType, FileCoverage[]>): void {
  const typesCount = Object.keys(report).length;
  logger.info(
    `Collected documentation coverage for ${pluralizeToken('type', typesCount)} of ${pluralize('entity', typesCount)}`,
  );
  if (!logger.isVerbose()) {
    return;
  }

  logger.debug(
    formatAsciiTable({
      columns: [
        { key: 'type', label: 'Entity', align: 'left' },
        { key: 'covered', label: 'Hits', align: 'right' },
        { key: 'total', label: 'Found', align: 'right' },
        { key: 'coverage', label: 'Coverage', align: 'right' },
      ],
      rows: objectToEntries(report)
        .map(([type, files]) => {
          const stats = aggregateCoverageStats(files);
          return {
            ...stats,
            type: capitalize(type),
            coverage: formatCoveragePercentage(stats),
          };
        })
        .toSorted((a, b) => b.total - a.total),
    }),
  );
}