Linters: remove godox
and add exclude rule for forbidigo
in mage files
#31433
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?
This PR adjusts the linter configuration, so we get less noise. The two impacted linters are
godox
andforbidigo
.Why is it important?
godox
is used to track down TODO, FIXME, etc. comments. Instead developers should open tickets in their issue trackers. Beats code is full of such comments without actual issues to back them up. I think the comments are valuable when we are debugging. But let's be honest, we are not going to fix all of the problems. Also, we cannot really open a valuable follow-up issue for such comments because we lack the required context.forbidigo
forbids us to usefmt.Print*
. In the product code it makes sense. However, inmage
we constantly print to stdout to give feedback to the developer. In mage targets and mage files, usingfmt.Print*
is the standard and should be valid.Checklist
- [ ] My code follows the style guidelines of this project- [ ] I have commented my code, particularly in hard-to-understand areas- [ ] I have made corresponding changes to the documentation- [ ] I have made corresponding change to the default configuration files- [ ] I have added tests that prove my fix is effective or that my feature works- [ ] I have added an entry inCHANGELOG.next.asciidoc
orCHANGELOG-developer.next.asciidoc
.