Disable unhelpful linters #957
Closed
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
Return update result instead of keeping it in temporary error and remove unneeded error definition. Signed-off-by: Nir Soffer <[email protected]>
The current nlreturn golangci-lint rule is bad, leading to worse code
style like:
if err != nil {
log.Info("Something failed");
return err;
}
Disable the rule so we can format code properly.
Signed-off-by: Nir Soffer <[email protected]>
The rules of this linter forces bad style and I could not find how to
disable the rule for adding blank line before return.
An example of bad style required by wsl:
if condition {
log.Info("Long message so we move extra arguments to next line...",
"name", name,
"namespace", namespace)
return true
}
Signed-off-by: Nir Soffer <[email protected]>
In drcluster module and tests. This was not possible before because of the golangci-lint nlreturn rule and wsl linter. Same change is needed in rest of the code, starting with these modules as example for possible changes. Signed-off-by: Nir Soffer <[email protected]>
nirs
requested review from
raghavendra-talur,
rakeshgm,
ShyamsundarR,
BenamarMk,
ELENAGER and
hatfieldbrian
|
go linters can be very prescriptive, my current philosophy is to leave them be unless the cause a very severe irritation that it needs to be dropped (which we have not yet come across). I would hence not drop these linters (or any linters) as it keeps the code formatted in certain very strict ways. We actually lost a few linters due to this PR #534 and potentially need to bring them back in, and also in general address some linter upgrade/deprecation warnings as seen here. This may need addressing soon than dropping linters. |
BenamarMk
approved these changes
Jul 24, 2023
|
Closing as stale, part of general cleanup. Please reopen and update if still required. (Also, we need to rekindle the linters efforts opened on other PRs than deprecating them) |
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.
Some linters used by golangci-lint are not helpful and enforce worse
code style. Disabling the linters allows improving the style and remove
unneeded obstacles for developers.
This pr modifies only 2 files to show some examples of possible formatting.
We can deffer the actual changes and modify the code as needed later.