feat: configurable regexp for coverage-ignore #212
Conversation
This file contains hidden or 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
…comment must follow any // coverage-ignore.
vladopajic
requested changes
Aug 26, 2025
There was a problem hiding this comment.
-
feature should be tested with unit tests on all levels
- `pkg/testcoverage/config_test.go``
TestConfigYamlParse
pkg/testcoverage/coverage/cover_test.go- new test that will check this functionality with different values used (similar to test
Test_findAnnotationsbut in this test second argument ofFindAnnotationsmust be used with different values)
- new test that will check this functionality with different values used (similar to test
pkg/testcoverage/check_test.go- a case in
func TestCheck(t *testing.T)where non default value ofIgnoreTextRegexis used
- a case in
- `pkg/testcoverage/config_test.go``
-
IgnoreTextRegexdoes not seem suitable name why notCoverageIgnoreRegex?
Comment on lines
+44
to
+50
| # (optional; default '//coverage-ignore') | ||
| # ignore-text-regex: Defines regular expressions to match specific comment patterns in your code | ||
| # that will be recognized as valid coverage ignore markers. | ||
| # | ||
| # this feature can be used to ensure team members properly document WHY coverage is being skipped, | ||
| # which helps maintain code quality and avoid unexplained coverage gaps. | ||
| ignore-text-regex: |
There was a problem hiding this comment.
Suggested change
| # (optional; default '//coverage-ignore') | |
| # ignore-text-regex: Defines regular expressions to match specific comment patterns in your code | |
| # that will be recognized as valid coverage ignore markers. | |
| # | |
| # this feature can be used to ensure team members properly document WHY coverage is being skipped, | |
| # which helps maintain code quality and avoid unexplained coverage gaps. | |
| ignore-text-regex: | |
| # (optional) | |
| # Defines regular expressions to match specific comment patterns in your code | |
| # that will be recognized as valid coverage ignore markers. | |
| # By default lines having `//coverage-ignore` are excluded from coverage statistic. | |
| ignore-text-regex: '' |
| @@ -83,6 +83,7 @@ func TestCheck(t *testing.T) { | |||
| Paths: []string{`cdn\.go$`, `github\.go$`, `cover\.go$`, `check\.go$`, `path\.go$`}, | |||
| }, | |||
| SourceDir: sourceDir, | |||
| IgnoreTextRegex: "", | |||
There was a problem hiding this comment.
why specify value us empty string (default)?
| @@ -44,6 +44,7 @@ func Test_GenerateCoverageStats(t *testing.T) { | |||
| stats, err = GenerateCoverageStats(Config{ | |||
| Profiles: []string{profileNOK}, | |||
| SourceDir: sourceDir, | |||
| IgnoreTextRegex: "", | |||
There was a problem hiding this comment.
why specify value us empty string (default)? here and other places in same file.
vladopajic
changed the title
…with-coverage-ignore
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.
Enforce Explanatory Comments with // coverage-ignore. When a user adds a // coverage-ignore annotation, the tool should enforce that an additional explanatory comment is provided.