client: address golangci var-naming issues #17582
Merged
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
20 tasks
|
/retest |
|
/ok-to-test |
jmhbnz
approved these changes
Mar 14, 2024
ahrtr
reviewed
Mar 14, 2024
| @@ -17,19 +17,19 @@ package logutil | |||
| import "fmt" | |||
|
|
|||
| const ( | |||
| JsonLogFormat = "json" | |||
There was a problem hiding this comment.
The only concern is this is a public/exported const. Probably we should
- deprecate the existing name and plan to remove it in next major or minor release and skip the linter for this const;
- add a new const
JSONLogFormat.
There was a problem hiding this comment.
Done, I deprecated JsonLogFormat.
Signed-off-by: Ivan Valdes <[email protected]>
ivanvc
force-pushed
the
address-client-var-naming-lint-rule
branch
from
2607ad0 to
578b784
Compare
ahrtr
approved these changes
Mar 15, 2024
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.
If we need to deprecate rather than rename an exported variable, we can add an ignore to the linter for that line.
Renamed exported variable:
logutil.JsonLogFormat->logutil.JSONLogFormatRenamed exported variables from internal packages:
endpoint.CREDS_REQUIRE->endpoint.CredsRequireendpoint.CREDS_DROP->endpoint.CredsDropendpoint.CREDS_OPTIONAL->endpoint.CredsOptionalExported renamed variables to unexported as they weren't being used anywhere outside their package:
verify.ENV_VERIFY->verify.envVerifyverify.ENV_VERIFY_VALUE_ALL->verify.envVerifyValueAllverify.ENV_VERIFY_VALUE_ASSERT->verify.envVerifyValueAssertAfter addressing these, the var-naming rule passes in the
clientdirectory.Relates to #17578
Please read https://github.com/etcd-io/etcd/blob/main/CONTRIBUTING.md#contribution-flow.