refactor: wip

Author: BioPhoton

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

@@ -1,32 +1,29 @@
 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,
-    createRunnerFunction,
-} 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: createRunnerFunction({
-            ...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

@@ -50,37 +50,6 @@ export type KnipCliOptions = Partial<{
 }>;
 export type RunnerOptions = KnipCliOptions & CustomReporterOptions;
 
-export function createRunnerConfig(options: RunnerOptions = {}): RunnerConfig {
-  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 {
-    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),
-      )}`,
-    ],
-    outputFile,
-  };
-}
-
 export function createRunnerFunction(
   options: RunnerOptions = {},
 ): RunnerFunction {

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, createRunnerFunction} from './index.js';
+import { runnerFunctionSchema } from '@code-pushup/models';
+import { createRunnerFunction } from './index.js';
 
 describe('createRunnerFunction', () => {
-  it('should return correct runner config object', () => {
+  it('should return correct runner function', () => {
     expect(() =>
-      runnerConfigSchema.parse(createRunnerFunction()),
+      runnerFunctionSchema.parse(createRunnerFunction()),
     ).not.toThrowError();
   });
 });