Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CoverageConfig "report" option apparently not implemented #2828

Open
miyasudokoro opened this issue Oct 15, 2024 · 0 comments
Open

CoverageConfig "report" option apparently not implemented #2828

miyasudokoro opened this issue Oct 15, 2024 · 0 comments

Comments

@miyasudokoro
Copy link

I am updating the documentation for CoverageConfig, and I realized the "report" option (boolean) does not seem to do anything. Setting coverageConfig.report to false did not stop any reports from being written.

The only place I can find it in the source code is here, in getCodeCoverage.ts:

  if (!watch && coverageConfig.report && coverageConfig.reporters?.includes('lcov')) {
    entries.push(
      `View full coverage report at ${underline(
        path.join(coverageConfig.reportDir ?? '', 'lcov-report', 'index.html'),
      )}`,
    );
  }

If someone has set "coverage" to true, then it would be very strange for them not to want any reports for that coverage. Would it make sense to remove the "report" option from CoverageConfig? Or should someone implement it, such that setting "report" to false would prevent reports from being generated?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant