refactor: replace failure Category raw string with constant #1196
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
ccoVeille
reviewed
Dec 25, 2024
Comment on lines
+8
to
+30
| const ( | ||
| FailureCategoryArgOrder = "arg-order" | ||
| FailureCategoryBadPractice = "bad practice" | ||
| FailureCategoryCodeStyle = "code-style" | ||
| FailureCategoryComments = "comments" | ||
| FailureCategoryComplexity = "complexity" | ||
| FailureCategoryContent = "content" | ||
| FailureCategoryErrors = "errors" | ||
| FailureCategoryImports = "imports" | ||
| FailureCategoryLogic = "logic" | ||
| FailureCategoryMaintenance = "maintenance" | ||
| FailureCategoryNaming = "naming" | ||
| FailureCategoryOptimization = "optimization" | ||
| FailureCategoryStyle = "style" | ||
| FailureCategoryTime = "time" | ||
| FailureCategoryTypeInference = "type-inference" | ||
| FailureCategoryUnaryOp = "unary-op" | ||
| FailureCategoryUnexportedTypeInAPI = "unexported-type-in-api" | ||
| FailureCategoryZeroValue = "zero-value" | ||
|
|
||
| failureCategoryInternal = "REVIVE_INTERNAL" | ||
| failureCategoryValidity = "validity" | ||
| ) |
There was a problem hiding this comment.
Most of them are exported. Do we need it?
Because of the modules and packages we do. But do we need them to be exported outside the module? If not, maybe it could be a internal/failure packages, allowing the constants to be unexported outside the module
There was a problem hiding this comment.
If someone wants to create a custom rule (not included in Revive), these might be useful.
I'd however make them typed, to avoid further direct strings used for this purpose.
There was a problem hiding this comment.
OK for me then.
And yes, good idea about the typed constants
chavacava
reviewed
Dec 26, 2024
| @@ -5,6 +5,30 @@ import ( | |||
| "go/token" | |||
| ) | |||
|
|
|||
| const ( | |||
| FailureCategoryArgOrder = "arg-order" | |||
There was a problem hiding this comment.
exported symbols need to be documented
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.
The PR adds constants for failure categories and replaces raw strings with respective constants.
We can optimize categories in a separate PR. E.g.,
FailureCategoryCodeStyleandFailureCategoryStyleshould be one category.