refactor: wip

Author: BioPhoton

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

@@ -1,29 +1,32 @@
 import path from 'node:path';
-import type { PluginConfig } from '@code-pushup/models';
-import { KNIP_AUDITS, KNIP_GROUPS, KNIP_PLUGIN_SLUG } from './constants.js';
-import { RunnerOptions, createRunnerConfig } from './runner/index.js';
+import type {PluginConfig} from '@code-pushup/models';
+import {KNIP_AUDITS, KNIP_GROUPS, KNIP_PLUGIN_SLUG} from './constants.js';
+import {
+    RunnerOptions,
+    createRunnerFunction,
+} from './runner/index.js';
 
 export type PluginOptions = RunnerOptions;
 
 export function knipPlugin(options: PluginOptions = {}): PluginConfig {
-  const {
-    outputFile = path.join(
-      '.code-pushup',
-      KNIP_PLUGIN_SLUG,
-      `knip-report-${Date.now()}.json`,
-    ),
-    ...runnerOptions
-  } = options;
-  return {
-    slug: KNIP_PLUGIN_SLUG,
-    title: 'Knip',
-    icon: 'folder-javascript',
-    description: 'A plugin to track dependencies and duplicates',
-    runner: createRunnerConfig({
-      ...runnerOptions,
-      outputFile,
-    }),
-    audits: KNIP_AUDITS,
-    groups: KNIP_GROUPS,
-  };
+    const {
+        outputFile = path.join(
+            '.code-pushup',
+            KNIP_PLUGIN_SLUG,
+            `knip-report-${Date.now()}.json`,
+        ),
+        ...runnerOptions
+    } = options;
+    return {
+        slug: KNIP_PLUGIN_SLUG,
+        title: 'Knip',
+        icon: 'folder-javascript',
+        description: 'A plugin to track dependencies and duplicates',
+        runner: createRunnerFunction({
+            ...runnerOptions,
+            outputFile,
+        }),
+        audits: KNIP_AUDITS,
+        groups: KNIP_GROUPS,
+    };
 }

packages/plugin-knip/src/lib/runner/index.ts

@@ -1,5 +1,10 @@
 import path from 'node:path';
-import type { RunnerConfig } from '@code-pushup/models';
+import type {
+  AuditOutputs,
+  RunnerConfig,
+  RunnerFunction,
+} from '@code-pushup/models';
+import { executeProcess, readJsonFile } from '@code-pushup/utils';
 import {
   KNIP_PLUGIN_SLUG,
   KNIP_REPORT_NAME,
@@ -75,3 +80,39 @@ export function createRunnerConfig(options: RunnerOptions = {}): RunnerConfig {
     outputFile,
   };
 }
+
+export function createRunnerFunction(
+  options: RunnerOptions = {},
+): RunnerFunction {
+  const {
+    outputFile = path.join(KNIP_PLUGIN_SLUG, KNIP_REPORT_NAME),
+    rawOutputFile,
+  } = options;
+
+  // Resolve the reporter path from the installed package
+  const reporterPath = '@code-pushup/knip-plugin/src/lib/reporter.js';
+
+  return async () => {
+    await executeProcess({
+      command: 'npx',
+      args: [
+        'knip',
+        // off as we want to CI to pass
+        '--no-exit-code',
+        // off by default to guarantee execution without interference
+        '--no-progress',
+        // code-pushup reporter is used from the installed package
+        `--reporter=${reporterPath}`,
+        // code-pushup reporter options are passed as string. Double JSON.stringify ensures proper escaping on all platforms
+        `--reporter-options=${JSON.stringify(
+          JSON.stringify({
+            outputFile,
+            rawOutputFile,
+          } satisfies CustomReporterOptions),
+        )}`,
+      ],
+    });
+
+    return readJsonFile<AuditOutputs>(outputFile);
+  };
+}

packages/plugin-knip/src/lib/runner/index.unit.test.ts

@@ -1,11 +1,11 @@
 import { describe, expect, it } from 'vitest';
 import { runnerConfigSchema } from '@code-pushup/models';
-import { createRunnerConfig } from './index.js';
+import {createRunnerConfig, createRunnerFunction} from './index.js';
 
-describe('runnerConfig', () => {
+describe('createRunnerFunction', () => {
   it('should return correct runner config object', () => {
     expect(() =>
-      runnerConfigSchema.parse(createRunnerConfig()),
+      runnerConfigSchema.parse(createRunnerFunction()),
     ).not.toThrowError();
   });
 });