Collapse output to 20 items

.changeset/clever-moose-occur.md

@@ -0,0 +1,5 @@
+---
+'@steiger/pretty-reporter': minor
+---
+
+Collapse the report to 20 diagnostics, add message about hidden diagnostics

packages/pretty-reporter/package.json

@@ -42,6 +42,7 @@
     "chalk": "^5.3.0",
     "figures": "^6.1.0",
     "picocolors": "^1.1.1",
-    "terminal-link": "^3.0.0"
+    "terminal-link": "^3.0.0",
+    "vitest": "^3.0.0-beta.2"
   }
 }

packages/pretty-reporter/src/collapse-diagnostics.test.ts

@@ -0,0 +1,141 @@
+import { describe, expect, it } from 'vitest'
+import { trimDiagnosticsToMeetQuota } from './collapse-diagnostics.js'
+
+const defaultLocation = {
+  path: '/users/user/file',
+}
+
+const defaultSeverity = 'error' as 'warn' | 'error'
+
+// dummy rules
+
+const rule1Message1 = {
+  message: 'First rule, first message',
+  ruleName: 'rule-1',
+  location: defaultLocation,
+  severity: defaultSeverity,
+}
+
+const rule1Message2 = {
+  message: 'First rule, second message',
+  ruleName: 'rule-1',
+  location: defaultLocation,
+  severity: defaultSeverity,
+}
+
+const rule1Message3 = {
+  message: 'First rule, third message',
+  ruleName: 'rule-1',
+  location: defaultLocation,
+  severity: defaultSeverity,
+}
+
+const rule2Message1 = {
+  message: 'Second rule, first message',
+  ruleName: 'rule-2',
+  location: defaultLocation,
+  severity: defaultSeverity,
+}
+
+const rule2Message2 = {
+  message: 'Second rule, second message',
+  ruleName: 'rule-2',
+  location: defaultLocation,
+  severity: defaultSeverity,
+}
+
+const rule3Message1 = {
+  message: 'Third rule, first message',
+  ruleName: 'rule-3',
+  location: defaultLocation,
+  severity: defaultSeverity,
+}
+
+const rule3Message2 = {
+  message: 'Third rule, second message',
+  ruleName: 'rule-3',
+  location: defaultLocation,
+  severity: defaultSeverity,
+}
+
+const rule4Message1 = {
+  message: 'Forth rule, first message',
+  ruleName: 'rule-4',
+  location: defaultLocation,
+  severity: defaultSeverity,
+}
+
+const rule4Message2 = {
+  message: 'Forth rule, second message',
+  ruleName: 'rule-4',
+  location: defaultLocation,
+  severity: defaultSeverity,
+}
+
+describe('trimDiagnosticsToMeetQuota', () => {
+  it('should return the same diagnostics if they are below the quota', () => {
+    const diagnosticPerRule = [
+      [rule1Message1, rule1Message2, rule1Message3],
+      [rule2Message1, rule2Message2],
+    ]
+
+    const result = trimDiagnosticsToMeetQuota(diagnosticPerRule, 10)
+
+    expect(result).toEqual(diagnosticPerRule)
+  })
+
+  it('should return no diagnostics if the quota is 0', () => {
+    const diagnosticPerRule = [
+      [rule1Message1, rule1Message2, rule1Message3],
+      [rule2Message1, rule2Message2],
+    ]
+
+    const result = trimDiagnosticsToMeetQuota(diagnosticPerRule, 0)
+
+    expect(result).toEqual([[], []])
+  })
+
+  it('should spread the quota evenly between rules', () => {
+    const diagnosticPerRule = [
+      [rule1Message1, rule1Message2, rule1Message3],
+      [rule2Message1, rule2Message2],
+    ]
+
+    const result = trimDiagnosticsToMeetQuota(diagnosticPerRule, 2)
+
+    expect(result).toEqual([[rule1Message1], [rule2Message1]])
+  })
+
+  it('should take first x rule diagnostics if the quota is less than the number of rules', () => {
+    const diagnosticPerRule = [
+      [rule1Message1, rule1Message2, rule1Message3],
+      [rule2Message1, rule2Message2],
+      [rule3Message1, rule3Message2],
+      [rule4Message1, rule4Message2],
+    ]
+
+    const result = trimDiagnosticsToMeetQuota(diagnosticPerRule, 3)
+
+    expect(result).toEqual([[rule1Message1], [rule2Message1], [rule3Message1]])
+  })
+
+  it('should not distribute the quota to non-existent items', () => {
+    const diagnostics = [[rule1Message1, rule1Message2, rule1Message3], [rule2Message1, rule2Message2], [rule3Message1]]
+
+    expect(trimDiagnosticsToMeetQuota(diagnostics, 6)).toEqual([
+      [rule1Message1, rule1Message2, rule1Message3],
+      [rule2Message1, rule2Message2],
+      [rule3Message1],
+    ])
+  })
+
+  it('should correctly stop distributing quota if the quota is greater than the number of diagnostics', () => {
+    const diagnostics = [[rule1Message1, rule1Message2, rule1Message3], [rule2Message1, rule2Message2], [rule3Message1]]
+
+    expect(trimDiagnosticsToMeetQuota(diagnostics, 10)).toEqual([
+      [rule1Message1, rule1Message2, rule1Message3],
+      [rule2Message1, rule2Message2],
+      [rule3Message1],
+    ])
+  })
+})

packages/pretty-reporter/src/collapse-diagnostics.ts

@@ -0,0 +1,51 @@
+import { Diagnostic } from '@steiger/types'
+
+const DIAGNOSTIC_QUOTA = 20
+
+function distributeQuota(buckets: Array<number>, quota: number) {
+  const allItems = buckets.reduce((acc, bucket) => acc + bucket, 0)
+  const quotaPerBucket = buckets.slice(0).fill(0)
+  let remainingQuota = quota
+
+  for (let i = 0; remainingQuota > 0; i += 1) {
+    const numOfItemsInBucket = buckets[i]
+    const assignedQuotaForBucket = quotaPerBucket[i]
+
+    // If it went beyond the last bucket, start from the first one
+    if (numOfItemsInBucket === undefined) {
+      i = -1
+      continue
+    }
+
+    // If the bucket already has the quota distributed for it or does not contain any items, skip it
+    if (assignedQuotaForBucket < numOfItemsInBucket && numOfItemsInBucket !== 0) {
+      quotaPerBucket[i] += 1
+      remainingQuota -= 1
+    }
+
+    // If it ran out of the items earlier than the quota, break
+    if (allItems === quota - remainingQuota) {
+      break
+    }
+  }
+
+  return quotaPerBucket
+}
+
+function sortDiagnostics(diagnostics: Diagnostic[]): Diagnostic[] {
+  const severityOrder = { error: 1, warn: 2 }
+
+  return diagnostics.slice(0).sort((a, b) => severityOrder[a.severity] - severityOrder[b.severity])
+}
+
+// Export for testing purposes to be able to pass a custom quota
+export function trimDiagnosticsToMeetQuota(diagnosticsPerRule: Array<Array<Diagnostic>>, quota: number) {
+  const diagnosticCountPerRule = diagnosticsPerRule.map((diagnostics) => diagnostics.length)
+  const quotaPerRule = distributeQuota(diagnosticCountPerRule, quota)
+  const sortedDiagnosticsPerRule = diagnosticsPerRule.map((diagnostics) => sortDiagnostics(diagnostics))
+
+  return sortedDiagnosticsPerRule.map((diagnostics, i) => diagnostics.slice(0, quotaPerRule[i]))
+}
+
+export const collapseDiagnostics = (diagnosticPerRule: Array<Array<Diagnostic>>) =>
+  trimDiagnosticsToMeetQuota(diagnosticPerRule, DIAGNOSTIC_QUOTA)

packages/pretty-reporter/src/group-diagnostics-by-rule.ts

@@ -0,0 +1,74 @@
+import { Diagnostic } from '@steiger/types'
+
+export function groupDiagnosticsByRule(diagnostics: Diagnostic[]): Diagnostic[][] {
+  const grouped: Record<string, Diagnostic[]> = {}
+
+  diagnostics.forEach((diagnostic) => {
+    if (!grouped[diagnostic.ruleName]) {
+      grouped[diagnostic.ruleName] = []
+    }
+    grouped[diagnostic.ruleName].push(diagnostic)
+  })
+
+  return Object.values(grouped)
+}
+
+if (import.meta.vitest) {
+  const { describe, it, expect } = import.meta.vitest
+
+  describe('groupDiagnosticsByRule', () => {
+    it('should group diagnostics by ruleName', () => {
+      const diagnostics: Diagnostic[] = [
+        {
+          ruleName: 'rule-1',
+          severity: 'error',
+          location: { path: '/users/user/project/src/app/index.ts' },
+          message: 'First rule, first message',
+        },
+        {
+          ruleName: 'rule-2',
+          severity: 'warn',
+          location: { path: '/users/user/project/src/app/index.ts' },
+          message: 'Second rule, first message',
+        },
+        {
+          ruleName: 'rule-1',
+          severity: 'warn',
+          location: { path: '/users/user/project/src/app/index.ts' },
+          message: 'First rule, second message',
+        },
+      ]
+
+      const result = groupDiagnosticsByRule(diagnostics)
+
+      expect(result).toHaveLength(2)
+      expect(result).toContainEqual([
+        {
+          ruleName: 'rule-1',
+          severity: 'error',
+          location: { path: '/users/user/project/src/app/index.ts' },
+          message: 'First rule, first message',
+        },
+        {
+          ruleName: 'rule-1',
+          severity: 'warn',
+          location: { path: '/users/user/project/src/app/index.ts' },
+          message: 'First rule, second message',
+        },
+      ])
+      expect(result).toContainEqual([
+        {
+          ruleName: 'rule-2',
+          severity: 'warn',
+          location: { path: '/users/user/project/src/app/index.ts' },
+          message: 'Second rule, first message',
+        },
+      ])
+    })
+
+    it('should return an empty array when no diagnostics are provided', () => {
+      const result = groupDiagnosticsByRule([])
+      expect(result).toEqual([])
+    })
+  })
+}

packages/pretty-reporter/src/index.ts

@@ -3,13 +3,19 @@ import figures from 'figures'
 import type { Diagnostic } from '@steiger/types'
 
 import { formatSingleDiagnostic } from './format-single-diagnostic.js'
+import { collapseDiagnostics } from './collapse-diagnostics.js'
+import { groupDiagnosticsByRule } from './group-diagnostics-by-rule.js'
 import { s } from './pluralization.js'
 
 export function formatPretty(diagnostics: Array<Diagnostic>, cwd: string) {
   if (diagnostics.length === 0) {
     return pc.green(`${figures.tick} No problems found!`)
   }
 
+  const collapsedDiagnostics = collapseDiagnostics(groupDiagnosticsByRule(diagnostics)).flat()
+  const collapsedDiagnosticsCount = collapsedDiagnostics.length
+  const initialDiagnosticsCount = diagnostics.length
+
   const errors = diagnostics.filter((d) => d.severity === 'error')
   const warnings = diagnostics.filter((d) => d.severity === 'warn')
 
@@ -22,8 +28,8 @@ export function formatPretty(diagnostics: Array<Diagnostic>, cwd: string) {
       .filter(Boolean)
       .join(' and ')
 
-  const autofixable = diagnostics.filter((d) => (d.fixes?.length ?? 0) > 0)
-  if (autofixable.length === diagnostics.length) {
+  const autofixable = collapsedDiagnostics.filter((d) => (d.fixes?.length ?? 0) > 0)
+  if (autofixable.length === collapsedDiagnostics.length) {
     footer += ` (all can be fixed automatically with ${pc.bold(pc.green('--fix'))})`
   } else if (autofixable.length > 0) {
     footer += ` (${autofixable.length} can be fixed automatically with ${pc.bold(pc.green('--fix'))})`
@@ -33,13 +39,16 @@ export function formatPretty(diagnostics: Array<Diagnostic>, cwd: string) {
 
   return (
     '\n' +
-    diagnostics.map((d) => formatSingleDiagnostic(d, cwd)).join('\n\n') +
+    collapsedDiagnostics.map((d) => formatSingleDiagnostic(d, cwd)).join('\n\n') +
     '\n\n' +
     // Due to formatting characters, it won't be exactly the size of the footer, that is okay
     pc.gray(figures.line.repeat(footer.length)) +
     '\n ' +
     footer +
-    '\n'
+    '\n ' +
+    (collapsedDiagnosticsCount < initialDiagnosticsCount
+      ? `${pc.reset(initialDiagnosticsCount - collapsedDiagnosticsCount)} diagnostics are not shown in the report as they exceed the limit allowed by Steiger`
+      : '')
   )
 }
 

packages/pretty-reporter/tsconfig.json

@@ -2,6 +2,7 @@
   "extends": "@steiger/tsconfig/base.json",
   "include": ["./src", "./reset.d.ts", "example/index.ts"],
   "compilerOptions": {
-    "tsBuildInfoFile": "node_modules/.cache/tsbuildinfo.json"
+    "tsBuildInfoFile": "node_modules/.cache/tsbuildinfo.json",
+    "types": ["vitest/importMeta"]
   }
 }

packages/pretty-reporter/vitest.config.ts

@@ -0,0 +1,7 @@
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+  test: {
+    includeSource: ['src/**/*.{js,ts}'],
+  },
+})