fix(plugin-eslint): pluralize audit display value based on count

Author: matejchalk

packages/plugin-eslint/src/lib/__snapshots__/runner.spec.ts.snap

@@ -84,7 +84,7 @@ exports[`executeRunner > should execute ESLint and create audit results for Reac
         },
       ],
     },
-    "displayValue": "1 warnings",
+    "displayValue": "1 warning",
     "score": 0,
     "slug": "no-unused-vars",
     "value": 1,
@@ -123,7 +123,7 @@ exports[`executeRunner > should execute ESLint and create audit results for Reac
         },
       ],
     },
-    "displayValue": "1 warnings",
+    "displayValue": "1 warning",
     "score": 0,
     "slug": "arrow-body-style",
     "value": 1,
@@ -162,7 +162,7 @@ exports[`executeRunner > should execute ESLint and create audit results for Reac
         },
       ],
     },
-    "displayValue": "1 warnings",
+    "displayValue": "1 warning",
     "score": 0,
     "slug": "eqeqeq",
     "value": 1,
@@ -185,7 +185,7 @@ exports[`executeRunner > should execute ESLint and create audit results for Reac
         },
       ],
     },
-    "displayValue": "1 warnings",
+    "displayValue": "1 warning",
     "score": 0,
     "slug": "max-lines-per-function",
     "value": 1,
@@ -330,7 +330,7 @@ exports[`executeRunner > should execute ESLint and create audit results for Reac
         },
       ],
     },
-    "displayValue": "1 warnings",
+    "displayValue": "1 warning",
     "score": 0,
     "slug": "prefer-const",
     "value": 1,
@@ -369,7 +369,7 @@ exports[`executeRunner > should execute ESLint and create audit results for Reac
         },
       ],
     },
-    "displayValue": "1 warnings",
+    "displayValue": "1 warning",
     "score": 0,
     "slug": "react-jsx-key",
     "value": 1,

packages/plugin-eslint/src/lib/runner/transform.ts

@@ -2,6 +2,7 @@ import type { AuditOutput, Issue } from '@code-pushup/models';
 import {
   compareIssueSeverity,
   countOccurrences,
+  formatCount,
   objectToEntries,
 } from '@code-pushup/utils';
 import type { Linter } from 'eslint';
@@ -41,7 +42,7 @@ function toAudit(slug: string, issues: LintIssue[]): AuditOutput {
   );
   const summaryText = objectToEntries(severityCounts)
     .sort((a, b) => -compareIssueSeverity(a[0], b[0]))
-    .map(([severity, count]) => `${count} ${severity}s`)
+    .map(([severity, count = 0]) => formatCount(count, severity))
     .join(', ');
   return {
     slug,

packages/utils/src/index.ts

@@ -17,8 +17,10 @@ export {
   countOccurrences,
   distinct,
   formatBytes,
+  formatCount,
   objectToEntries,
+  pluralize,
+  readJsonFile,
   slugify,
   toArray,
-  readJsonFile,
 } from './lib/utils';

packages/utils/src/lib/utils.spec.ts

@@ -7,6 +7,8 @@ import {
   countWeightedRefs,
   distinct,
   formatBytes,
+  formatCount,
+  pluralize,
   slugify,
   sumRefs,
   toArray,
@@ -175,3 +177,28 @@ describe('compareIssueSeverity', () => {
     ).toEqual(['info', 'warning', 'error'] satisfies Issue['severity'][]);
   });
 });
+
+describe('formatCount', () => {
+  it('should pluralize if count is greater than 1', () => {
+    expect(formatCount(5, 'audit')).toBe('5 audits');
+  });
+
+  it('should not pluralize if count is 1', () => {
+    expect(formatCount(1, 'audit')).toBe('1 audit');
+  });
+
+  it('should pluralize if count is 0', () => {
+    expect(formatCount(0, 'audit')).toBe('0 audits');
+  });
+});
+
+describe('pluralize', () => {
+  it.each([
+    ['warning', 'warnings'],
+    ['error', 'errors'],
+    ['category', 'categories'],
+    ['status', 'statuses'],
+  ])('should pluralize "%s" as "%s"', (singular, plural) => {
+    expect(pluralize(singular)).toBe(plural);
+  });
+});

packages/utils/src/lib/utils.ts

@@ -77,3 +77,18 @@ export async function readJsonFile(path: string): Promise<unknown> {
   const buffer = await readFile(path);
   return JSON.parse(buffer.toString());
 }
+
+export function formatCount(count: number, name: string) {
+  const text = count === 1 ? name : pluralize(name);
+  return `${count} ${text}`;
+}
+
+export function pluralize(text: string): string {
+  if (text.endsWith('y')) {
+    return text.slice(0, -1) + 'ies';
+  }
+  if (text.endsWith('s')) {
+    return `${text}es`;
+  }
+  return `${text}s`;
+}