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

Print a warning when running skunk without a coverage/.resultset.json #25

Closed
etagwerker opened this issue Feb 8, 2020 · 5 comments · Fixed by #48
Closed

Print a warning when running skunk without a coverage/.resultset.json #25

etagwerker opened this issue Feb 8, 2020 · 5 comments · Fixed by #48
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@etagwerker
Copy link
Member

In the README.md:

To get the best results, make sure that you have coverage/.resultset.json in
your application directory. That way skunk knows what's the status of your
test suite + code coverage.

Running skunk without that file is kind of pointless. The whole idea of the "StinkScore" is to combine RubyCritic's cost with SimpleCov's lack of coverage, in order to get a realistic "StinkScore"

So we should make sure the user understands that the scores that they're getting is not that useful.

@etagwerker etagwerker added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 8, 2020
@bronzdoc
Copy link
Contributor

bronzdoc commented Feb 8, 2020

If the result without coverage/.resultset.json is not useful then we should make it a requirement to run skunk

@bronzdoc
Copy link
Contributor

ping @etagwerker

@bronzdoc bronzdoc self-assigned this Feb 12, 2020
@etagwerker
Copy link
Member Author

@bronzdoc I don't think we should make it a requirement, I think it should output a noticeable warning. We have to assume that sometimes a project has no test suite, so they won't have code coverage data, but as they add coverage to their codebase, they might want to see the evolution of their stink score average (related to #5)

@FionaDL
Copy link
Member

FionaDL commented Apr 20, 2020

@etagwerker @bronzdoc Maybe there should also be a note in the documentation about having to change the path within the file?

@etagwerker
Copy link
Member Author

@FionaDL I think that is an issue in SimpleCov, not skunk -> https://github.com/colszowka/simplecov

I think it would be useful if SimpleCov had a way to generate coverage/.resultset.json with relative paths, instead of absolute paths.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants