Fix JSON tag linting for list types #171
Conversation
k8s-ci-robot
added
the
do-not-merge/work-in-progress
|
[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
cncf-cla: yes
The linter was incorrectly skipping JSON tag validation for list types (structs with TypeMeta, ListMeta, and Items fields). This allowed list types with missing or incorrect JSON tags to pass validation, which could cause serialization/deserialization issues. Signed-off-by: Sascha Grunert <sgrunert@redhat.com>
saschagrunert
force-pushed
the
fix-issue-147-list-types-linting
branch
from
896a0d7 to
7b5248f
Compare
k8s-ci-robot
removed
the
do-not-merge/work-in-progress
k8s-ci-robot
added
the
lgtm
| // inspectFieldsIncludingListTypes iterates over fields in structs, including list types. | ||
| // This is a custom implementation that bypasses the inspector's InspectFields helper | ||
| // to ensure list types are also linted for proper JSON tags. | ||
| func (a *analyzer) inspectFieldsIncludingListTypes( |
There was a problem hiding this comment.
Looks like we will iterate over all the fields we iterated on in the normal inspector again by doing this, is that right?
There was a problem hiding this comment.
Yes, one alternative was to change the normal inspector, but that would affect all linters, which is why I decided to keep the change scoped to jsontags.
There was a problem hiding this comment.
I guess if we are iterating again, we may as well just skip the first pass no?
There was a problem hiding this comment.
The alternative is to somehow have options to how the inspector iterates (maybe adding a CheckFieldsIncludingListTypes) and using that here instead? Then internally there can be some sharing?
4 participants
The linter was incorrectly skipping JSON tag validation for list types (structs with TypeMeta, ListMeta, and Items fields). This allowed list types with missing or incorrect JSON tags to pass validation, which could cause serialization/deserialization issues.
Fixes #147