chore(fmt): Enable disabled linters in global scope #238
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
Codecov Report
@@ Coverage Diff @@
## main #238 +/- ##
===========================================
- Coverage 55.81% 40.33% -15.49%
===========================================
Files 44 46 +2
Lines 2012 2162 +150
===========================================
- Hits 1123 872 -251
- Misses 781 1230 +449
+ Partials 108 60 -48
Continue to review full report at Codecov.
|
yitsushi
force-pushed
the
168-linter
branch
6 times, most recently
from
0272eb0 to
4bc0506
Compare
richardcase
previously approved these changes
Nov 11, 2021
.golangci.yml
Outdated
| - path: test/e2e/ | ||
| linters: | ||
| - goerr113 | ||
| - gomnd | ||
|
|
||
| linters: | ||
| disable-all: true |
There was a problem hiding this comment.
Should we flip this and set enable-all: true so we pick up new linters in the future? And then document any we explicitly disable
There was a problem hiding this comment.
enable-all: true is deprecated
There was a problem hiding this comment.
enabled all and disabled a selection of linters.
richardcase
previously approved these changes
Nov 11, 2021
Global options: * An explanation for all nolint annotations is required. Please do not just ignore it, tell us why is it ignored. == wsl * Fixed everywhere. == lll * Fix everywhere. * Added exception on `https://` links. == gochecknoglobals * Fixed everywhere. == gci * Fixed everywhere (with `golangci-lint run --fix`) == godox No TODO comments should live in the code without filed issues to track them. The reason is simple: if we have a comment with "todo", it has the same value as not having that comment at all, because no one will care about it. * No TODO, BUG, and FIXME comments in the code. * Except if it has a filed github issue reference.
Disabled linters: golint: The linter 'golint' is deprecated (since v1.41.0) due to: The repository of the linter has been archived by the owner. Replaced by revive. interfacer: The linter 'interfacer' is deprecated (since v1.38.0) due to: The repository of the linter has been archived by the owner. scopelint: The linter 'scopelint' is deprecated (since v1.39.0) due to: The repository of the linter has been deprecated by the owner. Replaced by exportloopref. maligned: fieldalignment tagliatelle: We have a yaml structure already and it uses snake_case keys, this linter wants us to replace with camelCase. That would require a design document and update all yaml outputs. ireturn: Question? nilnil: We are using nil, nil returns in case it was not an error, but the resource does not exist. Later we might want to return an error and check for error type on the caller side. exhaustivestruct: We don't want to specify all fields with nil and empty string. I see the point, if you specify and the default behavior is changed, it does not break the code.
richardcase
approved these changes
Nov 11, 2021
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 this PR does / why we need it:
Global options:
wsl
lll
https://links.gochecknoglobals
gci
golangci-lint run --fix)godox
No
TODOcomments should live in the code without filed issues to trackthem. The reason is simple: if we have a comment with "todo", it has the
same value as not having that comment at all, because no one will care
about it.
TODO,BUG, andFIXMEcomments in the code.Disabled linters: see commit message
Which issue(s) this PR fixes (optional, in
fixes #<issue number>(, fixes #<issue_number>, ...)format, will close the issue(s) when PR gets merged):Fixes #168
Special notes for your reviewer:
Removed some comments, because they are not relevant in the code yet. For example add CSI/CNI/RateLimit, we don't have a ticket about it, it's on a long term list, and when we add them, we can extend those structs (and that will basically part of the ticket), right now those comments had no value.
Checklist: