feat(plugin-coverage): add setup wizard binding (#1273)

hanna-skryl · web-flow · commit c91375ed40c1 · 2026-03-20T10:10:55.000-04:00
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -32,6 +32,7 @@
     "glob": "^11.0.1",
     "lighthouse": "^12.0.0",
     "lighthouse-logger": "2.0.1",
+    "magicast": "^0.3.5",
     "nx": "22.3.3",
     "ora": "^9.0.0",
     "parse-lcov": "^1.0.4",
diff --git a/packages/create-cli/README.md b/packages/create-cli/README.md
@@ -37,6 +37,18 @@ Each plugin exposes its own configuration keys that can be passed as CLI argumen
 | **`--eslint.patterns`**   | `string`  | `src` or `.`  | File patterns to lint      |
 | **`--eslint.categories`** | `boolean` | `true`        | Add recommended categories |
 
+#### Coverage
+
+| Option                          | Type                                       | Default              | Description                    |
+| ------------------------------- | ------------------------------------------ | -------------------- | ------------------------------ |
+| **`--coverage.framework`**      | `'jest'` \| `'vitest'` \| `'other'`        | auto-detected        | Test framework                 |
+| **`--coverage.configFile`**     | `string`                                   | auto-detected        | Path to test config file       |
+| **`--coverage.reportPath`**     | `string`                                   | `coverage/lcov.info` | Path to LCOV report file       |
+| **`--coverage.testCommand`**    | `string`                                   | auto-detected        | Command to run tests           |
+| **`--coverage.types`**          | `('function'` \| `'branch'` \| `'line')[]` | all                  | Coverage types to measure      |
+| **`--coverage.continueOnFail`** | `boolean`                                  | `true`               | Continue if test command fails |
+| **`--coverage.categories`**     | `boolean`                                  | `true`               | Add code coverage category     |
+
 ### Examples
 
 Run interactively (default):
diff --git a/packages/create-cli/package.json b/packages/create-cli/package.json
@@ -26,6 +26,7 @@
   },
   "type": "module",
   "dependencies": {
+    "@code-pushup/coverage-plugin": "0.120.1",
     "@code-pushup/eslint-plugin": "0.120.1",
     "@code-pushup/models": "0.120.1",
     "@code-pushup/utils": "0.120.1",
diff --git a/packages/create-cli/src/index.ts b/packages/create-cli/src/index.ts
@@ -1,6 +1,7 @@
 #! /usr/bin/env node
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
+import { coverageSetupBinding } from '@code-pushup/coverage-plugin';
 import { eslintSetupBinding } from '@code-pushup/eslint-plugin';
 import { parsePluginSlugs, validatePluginSlugs } from './lib/setup/plugins.js';
 import {
@@ -11,8 +12,11 @@ import {
 } from './lib/setup/types.js';
 import { runSetupWizard } from './lib/setup/wizard.js';
 
-// TODO: create, import and pass remaining plugin bindings (coverage, lighthouse, typescript, js-packages, jsdocs, axe)
-const bindings: PluginSetupBinding[] = [eslintSetupBinding];
+// TODO: create, import and pass remaining plugin bindings (lighthouse, typescript, js-packages, jsdocs, axe)
+const bindings: PluginSetupBinding[] = [
+  eslintSetupBinding,
+  coverageSetupBinding,
+];
 
 const argv = await yargs(hideBin(process.argv))
   .option('dry-run', {
diff --git a/packages/create-cli/src/lib/setup/types.ts b/packages/create-cli/src/lib/setup/types.ts
@@ -7,6 +7,7 @@ export type {
   PluginCodegenResult,
   PluginPromptDescriptor,
   PluginSetupBinding,
+  PluginSetupTree,
 } from '@code-pushup/models';
 
 export const CI_PROVIDERS = ['github', 'gitlab', 'none'] as const;
diff --git a/packages/create-cli/src/lib/setup/wizard.ts b/packages/create-cli/src/lib/setup/wizard.ts
@@ -32,6 +32,7 @@ import type {
   PluginCodegenResult,
   PluginSetupBinding,
   ScopedPluginResult,
+  Tree,
   WriteContext,
 } from './types.js';
 import { createTree } from './virtual-fs.js';
@@ -57,19 +58,19 @@ export async function runSetupWizard(
   const format = await promptConfigFormat(targetDir, cliArgs);
   const ciProvider = await promptCiProvider(cliArgs);
 
+  const tree = createTree(await getGitRoot());
+
   const resolved: ScopedPluginResult[] = await asyncSequential(
     selectedBindings,
     async binding => ({
       scope: binding.scope ?? 'project',
-      result: await resolveBinding(binding, cliArgs, targetDir),
+      result: await resolveBinding(binding, cliArgs, targetDir, tree),
     }),
   );
 
   const packageJson = await readPackageJson(targetDir);
   const isEsm = packageJson.type === 'module';
   const configFilename = resolveFilename('code-pushup.config', format, isEsm);
-
-  const tree = createTree(await getGitRoot());
   const writeContext: WriteContext = { tree, format, configFilename, isEsm };
 
   await (context.mode === 'monorepo' && context.tool != null
@@ -103,13 +104,14 @@ async function resolveBinding(
   binding: PluginSetupBinding,
   cliArgs: CliArgs,
   targetDir: string,
+  tree: Pick<Tree, 'read' | 'write'>,
 ): Promise<PluginCodegenResult> {
   const descriptors = binding.prompts ? await binding.prompts(targetDir) : [];
   const answers =
     descriptors.length > 0
       ? await promptPluginOptions(descriptors, cliArgs)
       : {};
-  return binding.generateConfig(answers);
+  return binding.generateConfig(answers, tree);
 }
 
 async function writeStandaloneConfig(
diff --git a/packages/models/src/index.ts b/packages/models/src/index.ts
@@ -118,6 +118,7 @@ export type {
   PluginCodegenResult,
   PluginPromptDescriptor,
   PluginSetupBinding,
+  PluginSetupTree,
 } from './lib/plugin-setup.js';
 export {
   auditReportSchema,
diff --git a/packages/models/src/lib/plugin-setup.ts b/packages/models/src/lib/plugin-setup.ts
@@ -47,13 +47,19 @@ export type ImportDeclarationStructure = {
 /** A single value in the answers record produced by plugin prompts. */
 export type PluginAnswer = string | string[] | boolean;
 
-/** Import declarations and plugin initialization code produced by `generateConfig`. */
+/** Code a plugin binding contributes to the generated config. */
 export type PluginCodegenResult = {
   imports: ImportDeclarationStructure[];
   pluginInit: string;
   categories?: CategoryConfig[];
 };
 
+/** Minimal file system abstraction passed to plugin bindings. */
+export type PluginSetupTree = {
+  read: (path: string) => Promise<string | null>;
+  write: (path: string, content: string) => Promise<void>;
+};
+
 /**
  * Defines how a plugin integrates with the setup wizard.
  *
@@ -71,5 +77,6 @@ export type PluginSetupBinding = {
   isRecommended?: (targetDir: string) => Promise<boolean>;
   generateConfig: (
     answers: Record<string, PluginAnswer>,
-  ) => PluginCodegenResult;
+    tree: PluginSetupTree,
+  ) => PluginCodegenResult | Promise<PluginCodegenResult>;
 };
diff --git a/packages/plugin-coverage/package.json b/packages/plugin-coverage/package.json
@@ -36,6 +36,7 @@
   "dependencies": {
     "@code-pushup/models": "0.120.1",
     "@code-pushup/utils": "0.120.1",
+    "magicast": "^0.3.5",
     "parse-lcov": "^1.0.4",
     "zod": "^4.2.1"
   },
diff --git a/packages/plugin-coverage/src/index.ts b/packages/plugin-coverage/src/index.ts
@@ -1,5 +1,6 @@
 import { coveragePlugin } from './lib/coverage-plugin.js';
 
 export default coveragePlugin;
+export { coverageSetupBinding } from './lib/binding.js';
 export type { CoveragePluginConfig } from './lib/config.js';
 export { getNxCoveragePaths } from './lib/nx/coverage-paths.js';
diff --git a/packages/plugin-coverage/src/lib/binding.ts b/packages/plugin-coverage/src/lib/binding.ts
diff --git a/packages/plugin-coverage/src/lib/binding.unit.test.ts b/packages/plugin-coverage/src/lib/binding.unit.test.ts
diff --git a/packages/plugin-coverage/src/lib/config-file.ts b/packages/plugin-coverage/src/lib/config-file.ts
diff --git a/packages/plugin-coverage/src/lib/config-file.unit.test.ts b/packages/plugin-coverage/src/lib/config-file.unit.test.ts
