refactor: wip

Author: BioPhoton

e2e/plugin-knip-e2e/tests/reporter.e2e.test.ts

@@ -25,6 +25,7 @@ describe('knip reporter', () => {
     'lib',
     'reporter.js',
   );
+
   beforeAll(async () => {
     await cp(fixturesDir, testFileDir, { recursive: true });
     await restoreNxIgnoredFiles(testFileDir);

packages/plugin-knip/src/lib/reporter/__snapshots__/reporter.unit.test.ts.snap

@@ -47,7 +47,7 @@ exports[`knipReporter > should produce valid audit outputs 1`] = `
       ],
     },
     "score": 0,
-    "slug": "devdependencies",
+    "slug": "dev-dependencies",
     "value": 1,
   },
   {
@@ -63,7 +63,7 @@ exports[`knipReporter > should produce valid audit outputs 1`] = `
       ],
     },
     "score": 0,
-    "slug": "optionalpeerdependencies",
+    "slug": "optional-peer-dependencies",
     "value": 1,
   },
   {
@@ -136,7 +136,7 @@ exports[`knipReporter > should produce valid audit outputs 1`] = `
   },
   {
     "score": 1,
-    "slug": "nsexports",
+    "slug": "ns-exports",
     "value": 0,
   },
   {
@@ -161,7 +161,7 @@ exports[`knipReporter > should produce valid audit outputs 1`] = `
   },
   {
     "score": 1,
-    "slug": "nstypes",
+    "slug": "ns-types",
     "value": 0,
   },
   {
@@ -181,7 +181,7 @@ exports[`knipReporter > should produce valid audit outputs 1`] = `
       ],
     },
     "score": 0,
-    "slug": "enummembers",
+    "slug": "enum-members",
     "value": 1,
   },
   {
@@ -201,7 +201,7 @@ exports[`knipReporter > should produce valid audit outputs 1`] = `
       ],
     },
     "score": 0,
-    "slug": "classmembers",
+    "slug": "class-members",
     "value": 1,
   },
   {

packages/plugin-knip/src/lib/reporter/utils.ts

@@ -13,17 +13,18 @@ import type {
   IssueSeverity as CondPushupIssueSeverity,
   Issue as CpIssue,
 } from '@code-pushup/models';
-import { formatGitPath, getGitRoot } from '@code-pushup/utils';
+import {
+  formatGitPath,
+  getGitRoot,
+  slugify,
+  toSentenceCase,
+} from '@code-pushup/utils';
 import {
   ISSUE_RECORDS_TYPES,
   ISSUE_SET_TYPES,
   ISSUE_TYPES,
 } from '../constants.js';
-import {
-  ISSUE_TYPE_MESSAGE,
-  ISSUE_TYPE_TITLE,
-  ISSUE_TYPE_TO_SLUG,
-} from './constants.js';
+import { ISSUE_TYPE_MESSAGE } from './constants.js';
 
 const severityMap: Record<KnipSeverity | 'unknown', CondPushupIssueSeverity> = {
   unknown: 'info',
@@ -129,22 +130,15 @@ export function knipToCpReport({
   issues: rawIssues,
   report,
 }: Pick<ReporterOptions, 'issues' | 'report'>): Promise<AuditOutputs> {
-  // When used as a knip reporter, always return ALL audits to match plugin configuration
-  // When called directly (tests), filter based on what's provided
-  const shouldReturnAllAudits = report != null;
-  const issueTypesToInclude = shouldReturnAllAudits
-    ? ISSUE_TYPES
-    : ISSUE_TYPES.filter((issueType) => rawIssues[issueType] != null);
-
   return Promise.all(
-    issueTypesToInclude.map(async (issueType): Promise<AuditOutput> => {
-      // Only process issues if this type is enabled in the report (or if no report filter)
+    ISSUE_TYPES.map(async (issueType): Promise<AuditOutput> => {
+      // Only process issues if this type is enabled in the report
       const isEnabled = !report || report[issueType];
       const issues = isEnabled ? await toIssues(issueType, rawIssues) : [];
 
       return {
-        slug: ISSUE_TYPE_TO_SLUG[issueType],
-        score: issues.length === 0 ? 1 : 0,
+        slug: slugify(toSentenceCase(issueType)),
+        score: issues.length === 0 && isEnabled ? 1 : 0,
         value: issues.length,
         ...(issues.length > 0 ? { details: { issues } } : {}),
       };

packages/plugin-knip/src/lib/reporter/utils.unit.test.ts

@@ -264,7 +264,7 @@ describe('toIssues', () => {
         files: new Set([
           '/User/projects/code-pushup-cli/packages/utils/src/index.js',
         ]),
-      }),
+      } as KnipIssues),
     ).resolves.toStrictEqual([
       expect.objectContaining({
         message: expect.stringMatching('Unused file'),
@@ -294,10 +294,10 @@ describe('toIssues', () => {
                 '/User/projects/code-pushup-cli/packages/utils/src/index.js',
               symbol: 'CliUi',
               severity: 'error',
-            },
+            } as unknown as KnipIssue,
           },
         },
-      }),
+      } as unknown as KnipIssues),
     ).resolves.toStrictEqual([
       expect.objectContaining({
         message: expect.stringMatching('CliUi'),
@@ -312,59 +312,88 @@ describe('toIssues', () => {
 
 describe('knipToCpReport', () => {
   it('should return empty audits if no report is flagged positive', async () => {
-    await expect(
-      knipToCpReport({
-        issues: {},
-      } as ReporterOptions),
-    ).resolves.toStrictEqual([]);
+    const result = await knipToCpReport({
+      issues: {},
+      report: {},
+    } as ReporterOptions);
+
+    expect(result).toEqual(
+      expect.arrayContaining([expect.objectContaining({ score: 0, value: 0 })]),
+    );
   });
 
   it('should return only audits flagged in report object', async () => {
-    await expect(
-      knipToCpReport({
-        issues: {
-          dependencies: {},
-        },
-      } as ReporterOptions),
-    ).resolves.toStrictEqual(
+    const result = await knipToCpReport({
+      issues: {
+        dependencies: {},
+      },
+      report: { dependencies: true },
+    } as ReporterOptions);
+
+    expect(result).toEqual(
       expect.arrayContaining([
         expect.objectContaining({ slug: 'dependencies' }),
       ]),
     );
   });
 
+  it('should return readable audit slug derived from knip issueType', async () => {
+    const result = await knipToCpReport({
+      issues: {
+        optionalPeerDependencies: {},
+      },
+      report: { optionalPeerDependencies: true },
+    } as ReporterOptions);
+
+    expect(result).toEqual(
+      expect.arrayContaining([
+        expect.objectContaining({ slug: 'optional-peer-dependencies' }),
+      ]),
+    );
+  });
+
   it('should return audit result with number of issues as value', async () => {
-    await expect(
-      knipToCpReport({
-        issues: { files: new Set(['a.js', 'b.js', 'c.js']) },
-      } as ReporterOptions),
-    ).resolves.toStrictEqual([expect.objectContaining({ value: 3 })]);
+    const result = await knipToCpReport({
+      issues: { files: new Set(['a.js', 'b.js', 'c.js']) },
+      report: { files: true },
+    } as ReporterOptions);
+
+    expect(result).toEqual(
+      expect.arrayContaining([
+        expect.objectContaining({ slug: 'files', value: 3 }),
+      ]),
+    );
   });
 
   it('should return audit result without display value', async () => {
-    await expect(
-      knipToCpReport({
-        issues: { files: new Set(['main.js']) },
-      } as ReporterOptions),
-    ).resolves.toStrictEqual([
-      expect.not.objectContaining({ displayValue: expect.any(String) }),
-    ]);
+    const result = await knipToCpReport({
+      issues: { files: new Set(['main.js']) },
+      report: { files: true },
+    } as ReporterOptions);
+
+    // Check that the files audit doesn't have displayValue
+    const filesAudit = result.find((audit) => audit.slug === 'files');
+    expect(filesAudit).not.toHaveProperty('displayValue');
   });
 
   it('should score audits with empty issues with 1', async () => {
-    await expect(
-      knipToCpReport({
-        issues: { files: new Set() },
-      } as ReporterOptions),
-    ).resolves.toStrictEqual([expect.objectContaining({ score: 1 })]);
+    const result = await knipToCpReport({
+      issues: { files: new Set() },
+      report: { files: true },
+    } as ReporterOptions);
+
+    const filesAudit = result.find((audit) => audit.slug === 'files');
+    expect(filesAudit).toEqual(expect.objectContaining({ score: 1, value: 0 }));
   });
 
   it('should score audits with issues with 0', async () => {
-    await expect(
-      knipToCpReport({
-        issues: { files: new Set(['main.js']) },
-      } as ReporterOptions),
-    ).resolves.toStrictEqual([expect.objectContaining({ score: 0 })]);
+    const result = await knipToCpReport({
+      issues: { files: new Set(['main.js']) },
+      report: { files: true },
+    } as ReporterOptions);
+
+    const filesAudit = result.find((audit) => audit.slug === 'files');
+    expect(filesAudit).toEqual(expect.objectContaining({ score: 0, value: 1 }));
   });
 
   it('should return valid outputs schema', async () => {
@@ -384,7 +413,7 @@ describe('knipToCpReport', () => {
               col: 0,
               symbols: [],
               parentSymbol: '',
-            },
+            } as unknown as KnipIssue,
           },
           '/User/username/code-pushup-cli/examples/plugins/.eslintrc.json': {
             'jsonc-eslint-parser': {
@@ -393,11 +422,12 @@ describe('knipToCpReport', () => {
               filePath:
                 '/User/username/code-pushup-cli/packages/utils/package.json',
               severity: 'error',
-            },
+            } as unknown as KnipIssue,
           },
         } as IssueRecords,
       } as ReporterOptions['issues'],
-    });
+      report: { files: true, unlisted: true },
+    } as ReporterOptions);
     expect(() => auditOutputsSchema.parse(result)).not.toThrowError();
   });
 });