Detect and warn about incorrectly used ignore-comments #325
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thank you for the PR 🙇 . I think it makes sense to emit warning for avoiding unexpected behavior. It would be beneficial as long as existing behavior is maintained (just providing warning and doesn't throw error?) |
|
@parroty Thanks for the feedback. What about the coverage? Should we ignore coverage if there is only |
|
@RKushnir I believe it's already a large change, so I am wondering taking a reasonably small step (while maintaining existing behavior) would be an option? (rather than extending coverage?), but looking for your opinion, too. |
|
@parroty I agree. I think it's already a good progress if we just show the warnings. I'll try to update the PR soon. Later we can add some config option e.g. |
|
@parroty I updated the PR: reverted the behavior change as we discussed, added more tests and a changelog entry. Unless I missed something, it should be ready now. Thank you for your help. |
|
Thanks and very sorry about taking time to merge. I'll try merge and release during this week 🙇 . |
tonyrud
added a commit
to Vetspire/excoveralls
that referenced
this pull request
Sep 27, 2024
* Cobertura now handles defprotocol and defimpl definitions (parroty#306) * Cobertura now handles defprotocol and defimpl definitions * Cobertura, catch all if module type is unknown * Bump version and update CHANGELOG * Add Cobertura docs to README.md (parroty#312) * Update Elixir requirement to 1.11+ (parroty#316) * Update Elixir requirement to 1.11+ * Update deps * Replace hackney with httpc (parroty#311) * Replace hackney with httpc * SSL options * FIXUP * Cache fixed * Aaaah, caching again * FIXUP * Add missing apps to :extra_applications * Add better check for :public_key * Bump version and update CHANGELOG * Fix lcov 2.0 source file handling (parroty#315) Prior to 2.0 being released, `genhtml` was much better about handling source files from the following paths: * `test/support/some_helper.ex` * `lib/foo/bar.ex` But after 2.0 was released, when rendering with `genhtml` the paths would be mangled and look like the following: * `test/support/test/support/some_helper.ex` * `lib/foo/lib/foo/bar.ex` I have tried in vain with many permutations of `--prefix` when running `genhtml` but the ultimate fix that made all of this go away was using the absolute path for the source file (`SF`). * Update CHANGELOG * Remove erroneous line in ExCoveralls.poster (parroty#318) * Import `.coverdata` after test run and improve documentation (parroty#309) * Import `.coverdata` after test run and improve docs * Update README table of contents * Update README based on review suggestion Co-authored-by: Alberto Sartori <[email protected]> --------- Co-authored-by: Alberto Sartori <[email protected]> * Update CHANGELOG * Accept custom http options (parroty#319) * Accept custom http options * Add HTTP options docs to README * Bump version and update CHANGELOG * Always floor coverage instead of rounding (parroty#310) * Always floor coverage instead of rounding We do not want to report a 100% coverage when there are lines that are not covered. * Add option to restore previous ceil coverage behaviour * Bump version and update CHANGELOG * Update README examples (parroty#320) * Use explicit steps to remove 1.16 deprecation warning (parroty#322) * Update CHANGELOG and bump version * Detect and warn about incorrectly used ignore-comments (parroty#325) * Detect and warn about incorrectly used ignore-comments Resolves parroty#197. * Keep existing ignoring behavior * Improve formatting * Test more ignore-related warnings * Remove warning in the case of ignore-next-line at the EOF * Test the warning output * Add a changelog entry * Adjust test descriptions --------- Co-authored-by: Roman <[email protected]> * Fix Elixir 1.17 single-quoted string warning (parroty#327) * Bump version and update CHANGELOG * add missing step for Cobertura's range (parroty#329) Without this change, the output is full of warnings such as ``` warning: negative steps are not supported in String.slice/2, pass 44..-1//1 instead ``` * Update CHANGELOG and version * Revert "add missing step for Cobertura's range (parroty#329)" (parroty#330) This reverts commit 00a96c4. * Revert version change * Update Range to use function syntax (parroty#332) * add missing step for Cobertura's range * Update Range to use function syntax * run tests in elixir 1.17 * fix test with relative path --------- Co-authored-by: parroty <[email protected]> * Update CHANGELOG and version --------- Co-authored-by: Rodrigue Villetard <[email protected]> Co-authored-by: parroty <[email protected]> Co-authored-by: Artem Solomatin <[email protected]> Co-authored-by: Andrea Leopardi <[email protected]> Co-authored-by: Matthew Johnston <[email protected]> Co-authored-by: Zach Allaun <[email protected]> Co-authored-by: Alberto Sartori <[email protected]> Co-authored-by: Victor Rodrigues <[email protected]> Co-authored-by: gitneko <[email protected]> Co-authored-by: Roman <[email protected]> Co-authored-by: Roman <[email protected]> Co-authored-by: Hans Krutzer <[email protected]> Co-authored-by: Juan Peri <[email protected]> Co-authored-by: Kenta Nakase <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR addresses the issue of accidentally ignoring too much code coverage. The issue happens when you add
coveralls-ignore-startbut forget to add the corresponding-ignore-stop. With this change, excoveralls is going to discard the un-closed ignore-block (i.e. not ignore the coverage) and give you a warning, so that you can more easily spot the mistake.Besides the main goal, this change also adds a few other useful warnings to let you know about redundant or invalid ignore-comments, which I previously outlined. This is an optional part, and we could remove it or split it into a separate PR if that would be more appropriate.
The most interesting part for review is
ignore.exandignore_test.exs.Here's what the warnings look like in the console output
The PR is unfinished, it's missing some of the final touches: some tests, changelog entry, version bump, readme update. But it's feature-complete and so I would love to get early feedback, in case I need to change anything before I polish it. I'm looking forward to your thoughts and suggestions.Resolves #197.