WIP: Fix marker detection for fields with orphaned markers #199
+170
−22
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
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/L
saschagrunert
changed the title
saschagrunert
force-pushed
the
fix-field-orphaned-markers
branch
4 times, most recently
from
2082515 to
c0f32c7
Compare
k8s-ci-robot
removed
the
do-not-merge/work-in-progress
Markers separated from field declarations by blank lines were not being
detected.
Example:
type FooStatus struct {
// +optional
// +listType=map
// Conditions update as changes occur.
Conditions []metav1.Condition
}
The fix detects orphaned marker blocks (containing only markers, no
prose) that precede a field's doc comment, while avoiding false
positives from adjacent field markers.
Performance optimizations:
- Pre-compute field Doc comment map to avoid O(n²) complexity
- Use regex validation instead of full marker parsing in containsOnlyMarkers
- Results in 93-95% reduction in AST node visits for files with orphaned markers
kubernetes-sigs#53
Signed-off-by: Sascha Grunert <sgrunert@redhat.com>
saschagrunert
force-pushed
the
fix-field-orphaned-markers
branch
from
c0f32c7 to
19f1732
Compare
saschagrunert
changed the title
k8s-ci-robot
added
the
do-not-merge/work-in-progress
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Markers separated from field declarations by blank lines were not being detected.
The fix detects orphaned marker blocks (containing only markers, no prose) that precede a field's doc comment, while avoiding false positives from adjacent field markers.
Fixes #53