🌱 Add sub-modules in go lint and fix reported issues #897
Conversation
This file contains 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
|
First of all, thank you for this. I really appreciate you taking the effort and doing this without anyone asking. Second, unfortunately, I already went down this route and did not open this exact PR because of the same things you did to avoid the issues:
Ultimately we need a special linter config for the |
My suggestion is to refactor this PR to include the fixes to the linter errors, such as ending comments with a |
akutz
reviewed
Feb 19, 2025
dilyar85
force-pushed
the
fix/go-lint
branch
from
30484b2 to
7623fab
Compare
dilyar85
force-pushed
the
fix/go-lint
branch
from
7623fab to
4da7686
Compare
dilyar85
force-pushed
the
fix/go-lint
branch
from
4da7686 to
be48a60
Compare
Minimum allowed line rate is |
aruneshpa
approved these changes
Feb 27, 2025
| @@ -48,6 +48,13 @@ PROJECT_SLUG := github.com/vmware-tanzu/vm-operator | |||
| # ROOT_DIR_IN_GOPATH is non-empty if ROOT_DIR is in the GOPATH. | |||
| ROOT_DIR_IN_GOPATH := $(findstring $(GOPATH)/src/$(PROJECT_SLUG),$(ROOT_DIR)) | |||
|
|
|||
| # R_WILDCARD recursively searches for a file that matches $1. | |||
| @@ -48,6 +48,13 @@ PROJECT_SLUG := github.com/vmware-tanzu/vm-operator | |||
| # ROOT_DIR_IN_GOPATH is non-empty if ROOT_DIR is in the GOPATH. | |||
| ROOT_DIR_IN_GOPATH := $(findstring $(GOPATH)/src/$(PROJECT_SLUG),$(ROOT_DIR)) | |||
|
|
|||
| # R_WILDCARD recursively searches for a file that matches $1. | |||
| R_WILDCARD=$(wildcard $(1)$(2)) $(foreach DIR,$(wildcard $(1)*),$(call R_WILDCARD,$(DIR)/,$(2))) | |||
There was a problem hiding this comment.
Also, I think $(foreach DIR,$(wildcard $(1)*) also lists files in $1, so you should change it to $(foreach DIR,$(wildcard $(1)*/)?
| continue; \ | ||
| fi; \ | ||
| echo "Running golangci-lint in $$dir"; \ | ||
| (cd $$dir && $(GOLANGCI_LINT_ABS_PATH) run -v $(GOLANGCI_LINT_FLAGS)); \ |
There was a problem hiding this comment.
Are GO_MOD_DIRS relative paths? If so I am curious how cd $$dir is working here since you pasted the output of running this target in your Testing Done section.
| @@ -16,6 +16,7 @@ package utilconversion | |||
| import ( | |||
| "math/rand" | |||
|
|
|||
| //nolint:depguard | |||
There was a problem hiding this comment.
I am curious why we are hitting this. Is this now included in the allowed imports? Or this is because of deprecation etc?
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.
What does this PR do, and why is it needed?
Currently
golangci-lintdoesn't support multiple modules as reported in golangci/golangci-lint#828, so ourapi/and other submodules are never being linted.This PR addresses this by updating the
lint-goMakefile target to run thegolangci-lintcommand in each module.The
.golangci.ymlis updated to ignore some of the rules specific to_conversion.gofiles by using thepath:param.Which issue(s) is/are addressed by this PR?
Fixes N/A.
Are there any special notes for your reviewer:
make lint-go-fullcommand locally and passed:make fixdidn't fix issues that were explicitly excluded.Please add a release note if necessary:
📚 Documentation preview 📚: https://vm-operator--897.org.readthedocs.build/en/897/