feat(learn): Collecting code coverage by avivkeller · Pull Request #7006 · nodejs/nodejs.org · GitHub

Description

This PR introduces a learning article on collecting code coverage in Node.js. However, it should not be merged until support for thresholds is included in the next semver-minor release, which is expected to be next week.

Related Issues

Support for code coverage: nodejs/node#46017
Support for code coverage inclusion/exclusion: nodejs/node#53553
Support for code coverage thresholds: nodejs/node#54429

Check List

I have read the Contributing Guidelines and made commit messages that follow the guideline.
I have run npm run format to ensure the code follows the style guide.
I have run npm run test to check if all tests are passing.
I have run npx turbo build to check if the website builds without errors.
[N/A] I've covered new added functionality with unit tests if necessary.

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
nodejs-org	✅ Ready (Inspect)	Visit Preview	Mar 22, 2025 1:36pm

This is currently marked as draft until the next semver-minor release of Node.js

https://nodejs-org-git-fork-redyetidev-code-coverage-learn-openjs.vercel.app/en/learn/test-runner/collecting-code-coverage

This is my first feedback, I think the introduction should be improved to put it in context. It should be remembered that the learn section is intended for non-experts.

Deployment failed with the following error:

The provided GitHub repository does not contain the requested branch or commit reference. Please ensure the repository is not empty.

LGTM !

Thanks for writing this, reads well

I've undrafted this, as the release proposal for v22.8.0 is ready at nodejs/node#54560, but it still shouldn't land until that does.

The expected release date is 2024-08-26 2024-09-02

Unit Test Coverage Report

Lines	Statements	Branches	Functions
	88.75% (742/836)	76.1% (242/318)	87.65% (142/162)

Unit Test Report

Tests	Skipped	Failures	Errors	Time
182	0 💤	0 ❌	0 🔥	6.096s ⏱️

this is great - looking forward to it

Can we have last review form @nodejs/test_runner

This is amazing. However I'm not sure we should be landing this before having stabilized the code coverage functionality.

I think this is okay to land once v22.8.0 releases, as it specifies that the --experimental-code-coverage command is needed, indicating that it is experimental. Would you like me to add a notice at the beginning that this is experimental, or just hold off until it's stabilized?

I think it's better to hold off until it's stable.

Is there an ETA for the stabilization of it?

IMO code coverage (w/o the --enable-source-maps flag) is pretty stable. I haven't seen many bugs with it in a while.

I asked a few weeks ago, and it was pointed out that statement coverage isn't supported, however, I'm not sure if that's in the plans for the immediate future of code coverage.

The original issue tracking the stability has been closed as completed, as all tasks were completed, which might mean it's ready to be stable. I've left a comment asking.

I'm fine keeping this open for the meantime, the problem is it becoming stale.

I'm also happy to close and reopen it, as chances are there will be some significant changes to the coverage reporter before stabilization, and this only collecting merge conflicts.

@avivkeller has there been any change yet? I feel we could merge the PR to be honest.

It's still experimental, but it's more stable, so I also think this can be merged.

@mcollina are you still blocking?

(I'll resolve the conflicts later today)

lgtm

Signed-off-by: Aviv Keller <38299977+RedYetiDev@users.noreply.github.com>

Co-authored-by: Michael Esteban <mickel13@gmail.com> Signed-off-by: Aviv Keller <38299977+RedYetiDev@users.noreply.github.com>

Signed-off-by: Aviv Keller <redyetidev@gmail.com>

Lighthouse Results

URL	Performance	Accessibility	Best Practices	SEO	Report
/en	🟢 93	🟢 100	🟢 100	🟢 91	🔗
/en/about	🟢 100	🟢 100	🟢 100	🟢 91	🔗
/en/about/previous-releases	🟢 100	🟢 100	🟢 100	🟢 92	🔗
/en/download	🟢 92	🟢 100	🟢 100	🟢 91	🔗
/en/blog	🟢 99	🟢 100	🟢 96	🟢 92	🔗

Article published: https://nodejs.org/en/learn/test-runner/collecting-code-coverage

vercel Bot deployed to Preview August 24, 2024 15:36 View deployment

vercel Bot deployed to Preview August 24, 2024 15:39 View deployment

AugustinMauroy reviewed Aug 24, 2024

View reviewed changes

avivkeller requested a review from AugustinMauroy August 24, 2024 17:13

AugustinMauroy approved these changes Aug 24, 2024

View reviewed changes

Comment thread apps/site/pages/en/learn/test-runner/collecting-code-coverage.md Outdated

vercel Bot deployed to Preview August 24, 2024 20:09 View deployment

mikeesto approved these changes Aug 25, 2024

View reviewed changes

Comment thread apps/site/pages/en/learn/test-runner/collecting-code-coverage.md Outdated

vercel Bot deployed to Preview August 25, 2024 11:26 View deployment

avivkeller marked this pull request as ready for review August 25, 2024 23:35

avivkeller requested a review from a team as a code owner August 25, 2024 23:35

avivkeller mentioned this pull request Aug 25, 2024

v22.8.0 proposal nodejs/node#54560

Merged

aymen94 approved these changes Aug 26, 2024

View reviewed changes

AugustinMauroy added the github_actions:pull-request Trigger Pull Request Checks label Aug 26, 2024

github-actions Bot removed the github_actions:pull-request Trigger Pull Request Checks label Aug 26, 2024

AugustinMauroy deployed to Storybook August 26, 2024 07:17 — with GitHub Actions View deployment

bmuenzenmeyer approved these changes Aug 26, 2024

View reviewed changes

mcollina reviewed Sep 2, 2024

View reviewed changes

mcollina requested changes Sep 2, 2024

View reviewed changes

AugustinMauroy added content Issues/pr concerning content learn Issues/pr concerning the learn section labels Sep 12, 2024

avivkeller mentioned this pull request Sep 26, 2024

doc: add missing : to run()'s globPatterns nodejs/node#55135

Merged

ovflowd reviewed Mar 22, 2025

View reviewed changes

mcollina approved these changes Mar 22, 2025

View reviewed changes

avivkeller and others added 4 commits March 22, 2025 09:26

feat(learn): Collecting code coverage

402be75

add links

5db4a92

Signed-off-by: Aviv Keller <38299977+RedYetiDev@users.noreply.github.com>

fix coverage command

16d95f4

Co-authored-by: Michael Esteban <mickel13@gmail.com> Signed-off-by: Aviv Keller <38299977+RedYetiDev@users.noreply.github.com>

fixup! add run() API support

0dc9b59

Signed-off-by: Aviv Keller <redyetidev@gmail.com>

vercel Bot deployed to Preview March 22, 2025 13:28 View deployment

fix formatting

795c6c7

avivkeller removed the blocked label Mar 22, 2025

avivkeller enabled auto-merge March 22, 2025 13:29

avivkeller added the github_actions:pull-request Trigger Pull Request Checks label Mar 22, 2025

github-actions Bot removed the github_actions:pull-request Trigger Pull Request Checks label Mar 22, 2025

avivkeller deployed to Storybook March 22, 2025 13:29 — with GitHub Actions View deployment

vercel Bot deployed to Preview March 22, 2025 13:29 View deployment

fix formatting

0754979

avivkeller added the github_actions:pull-request Trigger Pull Request Checks label Mar 22, 2025

github-actions Bot removed the github_actions:pull-request Trigger Pull Request Checks label Mar 22, 2025

avivkeller deployed to Storybook March 22, 2025 13:36 — with GitHub Actions View deployment

vercel Bot deployed to Preview March 22, 2025 13:36 View deployment

avivkeller added this pull request to the merge queue Mar 22, 2025

Merged via the queue into nodejs:main with commit a42315e Mar 22, 2025

avivkeller deleted the code-coverage-learn branch March 22, 2025 13:44

feat(learn): Collecting code coverage by avivkeller · Pull Request #7006 · nodejs/nodejs.org · GitHub

Uh oh!

feat(learn): Collecting code coverage - #7006

feat(learn): Collecting code coverage#7006avivkeller merged 6 commits intonodejs:mainnodejs/nodejs.org:mainfrom avivkeller:code-coverage-learnCopy head branch name to clipboard

Conversation

avivkeller commented Aug 24, 2024

Description

Related Issues

Check List

Uh oh!

vercel Bot commented Aug 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

avivkeller commented Aug 24, 2024

Uh oh!

avivkeller commented Aug 24, 2024

Uh oh!

AugustinMauroy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vercel Bot commented Aug 24, 2024

Uh oh!

AugustinMauroy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mikeesto left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

avivkeller commented Aug 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Aug 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Unit Test Coverage Report

Unit Test Report

Uh oh!

bmuenzenmeyer left a comment

Choose a reason for hiding this comment

Uh oh!

AugustinMauroy commented Sep 2, 2024

Uh oh!

mcollina left a comment

Choose a reason for hiding this comment

Uh oh!

mcollina left a comment

Choose a reason for hiding this comment

Uh oh!

avivkeller commented Sep 2, 2024

Uh oh!

mcollina commented Sep 2, 2024

Uh oh!

ovflowd commented Oct 28, 2024

Uh oh!

avivkeller commented Oct 28, 2024

Uh oh!

ovflowd commented Nov 17, 2024

Uh oh!

avivkeller commented Nov 17, 2024

Uh oh!

ovflowd left a comment

Choose a reason for hiding this comment

Uh oh!

avivkeller commented Mar 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mcollina left a comment

Choose a reason for hiding this comment

Uh oh!

feat(learn): Collecting code coverage#7006
avivkeller merged 6 commits into
nodejs:mainfrom
avivkeller:code-coverage-learn

vercel Bot commented Aug 24, 2024 •
edited
Loading

avivkeller commented Aug 25, 2024 •
edited
Loading

github-actions Bot commented Aug 26, 2024 •
edited
Loading

avivkeller commented Mar 22, 2025 •
edited
Loading

github-actions Bot commented Mar 22, 2025 •
edited
Loading