feat(plugin-coverage): add setup wizard binding by hanna-skryl · Pull Request #1273 · code-pushup/cli

hanna-skryl · 2026-03-19T00:07:12Z

Coverage plugin binding for the setup wizard. Auto-detects Jest/Vitest, prompts for coverage options with smart defaults, and generates plugin initialization code.

For Jest/Vitest, generateConfig receives the wizard's virtual tree and uses magicast (0.3.x, as the latest 0.5.x is incompatible with our moduleResolution: "node") to add an LCOV reporter to the test config. If the modification fails, a comment is prepended to pluginInit to remind the user to configure LCOV manually.

nx-cloud · 2026-03-19T00:08:39Z

View your CI Pipeline Execution ↗ for commit c0584a5

Command	Status	Duration	Result
`nx run ci:code-pushup -- merge-diffs --files=/h...`	✅ Succeeded	5s	View ↗
`nx run-many --targets=code-pushup --parallel=fa...`	✅ Succeeded	1m 29s	View ↗
`nx run-many --targets=code-pushup --parallel=fa...`	✅ Succeeded	13m 12s	View ↗
`nx run-many -t unit-test,int-test`	✅ Succeeded	1m 25s	View ↗

☁️ Nx Cloud last updated this comment at 2026-03-20 13:26:19 UTC

pkg-pr-new · 2026-03-19T00:09:09Z

Open in StackBlitz

@code-pushup/ci

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/ci@1273

@code-pushup/cli

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/cli@1273

@code-pushup/core

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/core@1273

@code-pushup/create-cli

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/create-cli@1273

@code-pushup/models

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/models@1273

@code-pushup/nx-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/nx-plugin@1273

@code-pushup/axe-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/axe-plugin@1273

@code-pushup/coverage-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/coverage-plugin@1273

@code-pushup/eslint-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/eslint-plugin@1273

@code-pushup/js-packages-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/js-packages-plugin@1273

@code-pushup/jsdocs-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/jsdocs-plugin@1273

@code-pushup/lighthouse-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/lighthouse-plugin@1273

@code-pushup/typescript-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/typescript-plugin@1273

@code-pushup/utils

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/utils@1273

commit: c0584a5

github-actions · 2026-03-19T00:17:57Z

Code PushUp

🤨 Code PushUp report has both improvements and regressions – compared current commit f620c71 with previous commit 28ccfcb.

🕵️ See full comparison in Code PushUp portal 🔍

🏷️ Categories

🏷️ Category	⭐ Previous score	⭐ Current score	🔄 Score change
Updates	🟡 72	🟡 73
Performance	🔴 36	🔴 36
Documentation	🟡 52	🟡 52
Code coverage	🟢 92	🟢 92
Bug prevention	🟡 75	🟡 75
Axe Accessibility	🟡 88	🟡 88
Code style	🟢 100	🟢 100	–
Security	🔴 0	🔴 0	–
Type Safety	🟡 67	🟡 67	–
Miscellaneous	🟡 67	🟡 67	–
Accessibility	🟢 92	🟢 92	–
Best Practices	🟢 100	🟢 100	–
SEO	🟢 92	🟢 92	–

👍 3 groups improved, 👎 1 group regressed, 👍 8 audits improved, 👎 3 audits regressed, 14 audits changed without impacting score

🗃️ Groups

🔌 Plugin	🗃️ Group	⭐ Previous score	⭐ Current score
JS packages	npm outdated dependencies	🟡 72	🟡 73
Lighthouse	Performance	🔴 36	🔴 36
JSDocs coverage	Documentation coverage	🟡 52	🟡 52
Code coverage	Code coverage metrics	🟢 92	🟢 92

30 other groups are unchanged.

🛡️ Audits

🔌 Plugin	🛡️ Audit	📏 Previous value	📏 Current value
Lighthouse	Max Potential First Input Delay	🟥 710 ms	🟥 560 ms
Lighthouse	First Contentful Paint	🟥 3.3 s	🟥 3.2 s
JS packages	Outdated npm dev dependencies.	🟨 61 outdated package versions (32 major, 24 minor, 5 patch)	🟨 62 outdated package versions (33 major, 23 minor, 6 patch)
Lighthouse	Speed Index	🟥 6.1 s	🟥 6.0 s
JS packages	Outdated npm prod dependencies.	🟨 22 outdated package versions (7 major, 12 minor, 3 patch)	🟨 23 outdated package versions (7 major, 13 minor, 3 patch)
JSDocs coverage	Variables coverage	🟥 291 undocumented variables	🟥 302 undocumented variables
JSDocs coverage	Functions coverage	🟥 635 undocumented functions	🟥 646 undocumented functions
JSDocs coverage	Types coverage	🟥 279 undocumented types	🟥 281 undocumented types
Code coverage	Function coverage	🟩 94 %	🟩 94 %
Code coverage	Line coverage	🟩 92.1 %	🟩 92.2 %
Code coverage	Branch coverage	🟨 89.1 %	🟨 89.1 %
Lighthouse	Largest Contentful Paint	🟥 14.0 s	🟥 9.9 s
Lighthouse	Uses efficient cache policy on static assets	🟨 31 resources found	🟨 31 resources found
Lighthouse	Avoids enormous network payloads	🟩 Total size was 2,417 KiB	🟩 Total size was 2,416 KiB
Lighthouse	Server Backend Latencies	🟩 1,390 ms	🟩 330 ms
Lighthouse	Reduce unused JavaScript	🟥 Potential savings of 298 KiB	🟥 Potential savings of 297 KiB
Lighthouse	Remove duplicate modules in JavaScript bundles	🟥 Potential savings of 112 KiB	🟥 Potential savings of 108 KiB
Lighthouse	JavaScript execution time	🟥 3.3 s	🟥 3.6 s
Lighthouse	Minimizes main-thread work	🟥 10.3 s	🟥 10.1 s
Lighthouse	Time to Interactive	🟥 14.7 s	🟥 14.5 s
Lighthouse	Metrics	🟩 100%	🟩 100%
Lighthouse	Reduce unused CSS	🟥 Potential savings of 111 KiB	🟥 Potential savings of 77 KiB
Lighthouse	Total Blocking Time	🟥 2,050 ms	🟥 2,100 ms
Lighthouse	Network Round Trip Times	🟩 50 ms	🟩 70 ms
Lighthouse	Initial server response time was short	🟩 Root document took 500 ms	🟩 Root document took 500 ms

653 other audits are unchanged.

github-actions · 2026-03-19T00:24:55Z

Code PushUp

🤨 Code PushUp report has both improvements and regressions – compared current commit f620c71 with previous commit 28ccfcb.

💼 Project `plugin-coverage`

🤨 Code PushUp report has both improvements and regressions.

🕵️ See full comparison in Code PushUp portal 🔍

🏷️ Category	⭐ Previous score	⭐ Current score	🔄 Score change
Code coverage	🟢 92	🟢 93
Documentation	🟡 69	🟡 68

4 other categories are unchanged.

👍 1 group improved, 👎 1 group regressed, 👍 3 audits improved, 👎 1 audit regressed, 2 audits changed without impacting score

🗃️ Groups

🔌 Plugin	🗃️ Group	⭐ Previous score	⭐ Current score	🔄 Score change
Code coverage	Code coverage metrics	🟢 92	🟢 93
JSDocs coverage	Documentation coverage	🟡 69	🟡 68

13 other groups are unchanged.

🛡️ Audits

🔌 Plugin	🛡️ Audit	📏 Previous value	📏 Current value
JSDocs coverage	Functions coverage	🟥 22 undocumented functions	🟥 33 undocumented functions
Code coverage	Function coverage	🟩 93.5 %	🟩 95.7 %
Code coverage	Line coverage	🟨 89.1 %	🟩 91 %
Code coverage	Branch coverage	🟨 89.6 %	🟨 89.7 %
JSDocs coverage	Variables coverage	🟥 13 undocumented variables	🟥 24 undocumented variables
JSDocs coverage	Types coverage	🟥 8 undocumented types	🟥 10 undocumented types

438 other audits are unchanged.

💼 Project `models`

🤨 Code PushUp report has both improvements and regressions.

🕵️ See full comparison in Code PushUp portal 🔍

🏷️ Category	⭐ Previous score	⭐ Current score	🔄 Score change
Documentation	🟡 67	🟡 67
Code coverage	🟢 94	🟢 94

2 other categories are unchanged.

👍 1 group improved, 👎 1 group regressed, 👍 1 audit improved, 👎 1 audit regressed

🗃️ Groups

🔌 Plugin	🗃️ Group	⭐ Previous score	⭐ Current score	🔄 Score change
JSDocs coverage	Documentation coverage	🟡 67	🟡 67
Code coverage	Code coverage metrics	🟢 94	🟢 94

10 other groups are unchanged.

🛡️ Audits

🔌 Plugin	🛡️ Audit	📏 Previous value	📏 Current value	🔄 Value change
JSDocs coverage	Types coverage	🟥 64 undocumented types	🟥 64 undocumented types
Code coverage	Line coverage	🟩 95 %	🟩 94.6 %

435 other audits are unchanged.

💼 Project `create-cli`

🥳 Code PushUp report has improved.

🕵️ See full comparison in Code PushUp portal 🔍

🏷️ Category	⭐ Previous score	⭐ Current score	🔄 Score change
Code coverage	🟢 90	🟢 90

5 other categories are unchanged.

👍 1 group improved, 👍 1 audit improved

🗃️ Groups

🔌 Plugin	🗃️ Group	⭐ Previous score	⭐ Current score	🔄 Score change
Code coverage	Code coverage metrics	🟢 90	🟢 90

14 other groups are unchanged.

🛡️ Audits

🔌 Plugin	🛡️ Audit	📏 Previous value	📏 Current value	🔄 Value change
Code coverage	Line coverage	🟩 91.2 %	🟩 91.2 %

442 other audits are unchanged.

11 other projects are unchanged.

matejchalk

The new adjustments mechanism is very elegant. 👍

packages/create-cli/README.md

packages/plugin-coverage/src/lib/binding.ts

packages/plugin-coverage/src/lib/config-file.unit.test.ts

matejchalk · 2026-03-19T15:16:59Z

packages/plugin-coverage/src/lib/config-file.unit.test.ts

+  it('should return CJS config unchanged', () => {
+    const input = `module.exports = { coverageReporters: ['text'] };`;
+    expect(addLcovReporter(input, 'jest')).toBe(input);
+  });


Aren't we able to add LCOV to CommonJS configs as well? I'm guessing that CommonJS configs are still very common for Jest.

magicast doesn't support CJS, and your comment made me think about the other cases where we can't reliably modify the config either (factory functions, variable references, missing files). Instead of trying to cover every edge case, I decided to make the binding tell the user when manual setup is needed.

generateConfig now receives the wizard's virtual tree, tries to add the LCOV reporter, and if it can't for any reason, prepends a comment to the generated plugin code.

The tree parameter is a minimal { read, write } contract that bindings can ignore if they don't need to modify files. It's not ideal to expose the tree this way, but I couldn't think of better alternatives. The LCOV change is arguably a side effect, but at the same time, failing to complete it would render the coverage plugin setup incomplete 😕

Let me know if you have other ideas for handling this.

generateConfig now receives the wizard's virtual tree, tries to add the LCOV reporter, and if it can't for any reason, prepends a comment to the generated plugin code.

This is a very good solution. I like it a lot. 🙂

It's not ideal to expose the tree this way

I think it's OK. All changes go through the tree; that's the main thing.

matejchalk

(I clicked Approve automatically without thinking. 🤦)

packages/models/src/lib/plugin-setup.ts

packages/plugin-coverage/src/lib/binding.unit.test.ts

feat(plugin-coverage): add setup wizard binding

6876789

hanna-skryl self-assigned this Mar 19, 2026

github-actions bot added 📖 Project documentation improvements or additions to the project documentation 🔬 testing writing tests 🧩 models 🧩 coverage-plugin 🛠️ tooling 🧩 create-cli labels Mar 19, 2026

hanna-skryl marked this pull request as ready for review March 19, 2026 00:28

hanna-skryl requested a review from matejchalk as a code owner March 19, 2026 00:28

matejchalk approved these changes Mar 19, 2026

View reviewed changes

matejchalk requested changes Mar 19, 2026

View reviewed changes

hanna-skryl added 3 commits March 19, 2026 14:36

refactor(plugin-coverage): improve config-file lcov handling

e4611f6

docs(plugin-coverage): fix option type

8b5433f

refactor(plugin-coverage): replace adjustments with tree

9bc20e0

matejchalk reviewed Mar 20, 2026

View reviewed changes

packages/models/src/lib/plugin-setup.ts Outdated Show resolved Hide resolved

packages/plugin-coverage/src/lib/binding.unit.test.ts Show resolved Hide resolved

hanna-skryl added 2 commits March 20, 2026 09:06

refactor(plugin-coverage): use explicit calls in binding tests

4396fb4

refactor(models): require tree param in generateConfig

c0584a5

Conversation

hanna-skryl commented Mar 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nx-cloud bot commented Mar 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pkg-pr-new bot commented Mar 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Mar 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code PushUp

🏷️ Categories

🗃️ Groups

🛡️ Audits

Uh oh!

github-actions bot commented Mar 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code PushUp

💼 Project plugin-coverage

🗃️ Groups

🛡️ Audits

💼 Project models

🗃️ Groups

🛡️ Audits

💼 Project create-cli

🗃️ Groups

🛡️ Audits

Uh oh!

matejchalk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

matejchalk Mar 19, 2026

Choose a reason for hiding this comment

Uh oh!

hanna-skryl Mar 19, 2026

Choose a reason for hiding this comment

Uh oh!

matejchalk Mar 20, 2026

Choose a reason for hiding this comment

Uh oh!

matejchalk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

hanna-skryl commented Mar 19, 2026 •

edited

Loading

nx-cloud bot commented Mar 19, 2026 •

edited

Loading

pkg-pr-new bot commented Mar 19, 2026 •

edited

Loading

github-actions bot commented Mar 19, 2026 •

edited

Loading

github-actions bot commented Mar 19, 2026 •

edited

Loading

💼 Project `plugin-coverage`

💼 Project `models`

💼 Project `create-cli`