Detect markers separated by blank lines from type declarations #187
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
k8s-ci-robot
added
the
do-not-merge/work-in-progress
k8s-ci-robot
added
the
cncf-cla: yes
k8s-ci-robot
added
the
size/L
saschagrunert
force-pushed
the
fix-issue-53-second-level-comment-bug
branch
13 times, most recently
from
6e5b936 to
41060d9
Compare
saschagrunert
changed the title
k8s-ci-robot
removed
the
do-not-merge/work-in-progress
JoelSpeed
reviewed
Nov 12, 2025
Comment on lines
214
to
218
| // SingleLineMarkerTest has a single marker separated by blank line. | ||
| // This marker should still be detected because it's part of the Doc comment group. | ||
| type SingleLineMarkerTest struct { | ||
| Name string `json:"name"` | ||
| } |
Contributor
There was a problem hiding this comment.
How do we know that the marker is being detected?
Member
Author
There was a problem hiding this comment.
Ah right. I've updated the implementation to actually detect single-line markers separated by blank lines.
saschagrunert
force-pushed
the
fix-issue-53-second-level-comment-bug
branch
from
41060d9 to
847529f
Compare
Contributor
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: saschagrunert The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
size/XL
saschagrunert
force-pushed
the
fix-issue-53-second-level-comment-bug
branch
from
847529f to
4a14f71
Compare
This fixes issue kubernetes-sigs#53 by detecting kubebuilder markers that are separated from type declarations by blank lines. Both single-line and multi-line marker groups are now properly detected. - Modified marker analyzer to check the previous comment group - Added extractOrphanedMarkers and helper functions - Added constants for marker prefix and separation limits - Added logic to skip commented-out code blocks - Renamed containsMultilineMarkers to containsMarkers for clarity - Added comprehensive test cases covering: - Multi-line markers with blank lines (BlankLineTest) - Single-line markers with blank lines (SingleLineMarkerTest) - Distance limits preventing false positives (TooFarAwayTest) - Commented-out code rejection (CommentedCodeTest) - List types with blank line markers (ServiceList) Signed-off-by: Sascha Grunert <sgrunert@redhat.com>
saschagrunert
force-pushed
the
fix-issue-53-second-level-comment-bug
branch
from
4a14f71 to
f28c4cf
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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 fixes issue #53 by detecting kubebuilder markers that are separated
from type declarations by blank lines. Both single-line and multi-line
marker groups are now properly detected.