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

[FEATURE] per-file minimum coverage #306

Closed
stevengunneweg opened this issue Sep 11, 2017 · 4 comments
Closed

[FEATURE] per-file minimum coverage #306

stevengunneweg opened this issue Sep 11, 2017 · 4 comments

Comments

@stevengunneweg
Copy link

Overview of the issue

I would like to have an option to set a per-file minimum coverage. Currently coverage only fails if the entire codebase falls below the threshold even though a single file could be completely undocumented.

Operating System, Node.js, npm, compodoc version(s)

OSX, NPM@5.4.0, Compodoc@1.0.1

Compodoc installed globally or locally ?

Installed v1.0.1 locally

Motivation for or Use Case

I'm using the coverageTest in CI but if someone doesn't document it does not necessarily fail the test.

Reproduce the error

Have a codebase of a certain coverage percentage (say 50%) and at least one file with a lower/no coverage. Run compodoc --coverageTest 50 and see that the test succeeds.

Suggest a Fix

I would like to have an optional flag to set the per-file minimum coverage like --coverageMinimum 30.

@stevengunneweg
Copy link
Author

@vogloblinsky I'm happy to see this has been worked on. Any idea when this feature will be released to NPM?

@vogloblinsky
Copy link
Contributor

Right now, i had a little fix on README file to do.
https://www.npmjs.com/package/@compodoc/compodoc

@stevengunneweg
Copy link
Author

stevengunneweg commented Oct 30, 2017

Awesome! Many thanks

UPDATE: Works like a charm 😃

@lock
Copy link

lock bot commented Oct 1, 2019

This issue has been automatically locked due to inactivity. Please file a new issue if you are encountering a similar or related problem. Why locking ? Having issues with the most up-to-date context.

@lock lock bot locked as resolved and limited conversation to collaborators Oct 1, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants