Scope stuct tag linter to dalec.Spec by default. #940
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
This was only ever intended to lint dalec.Spec, but is linting everything. For some cases we got hit by the linter for a type that is unrelated to the spec and just went ahead and fixed it to pass CI and just never got around to fixing the linter. Signed-off-by: Brian Goff <[email protected]>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refactors the struct tag linter to scope its validation to only types reachable from dalec.Spec, rather than checking all structs in all packages. Previously, the linter was incorrectly validating struct tags in unrelated types, which was not the intended behavior.
Changes:
- Implements type reachability analysis to only validate structs transitively referenced from
dalec.Spec - Adds package-level filtering to skip validation for packages that don't import or define the root type
- Adds comprehensive tests for the new scoping behavior
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| linters/yaml_json_tags.go | Implements type reachability analysis, adds flag support for configurable root type, and refactors analyzer creation into a factory function |
| linters/yaml_json_tags_test.go | Adds new tests for type scoping and updates existing tests to use pointer receiver syntax |
| cmd/lint/main.go | Updates to use the new analyzer factory function |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 was only ever intended to lint dalec.Spec, but is linting everything.
For some cases we got hit by the linter for a type that is unrelated to the spec and just went ahead and fixed it to pass CI and just never got around to fixing the linter.