feat: abstract ruletype enum with IRuleType #759
Conversation
| BUG("Bug"), | ||
| VULNERABILITY("Vulnerability"), | ||
| CODE_SMELL("Code_Smell"), | ||
| SECURITY_HOTSPOT("Security_Hotspot"); |
There was a problem hiding this comment.
Any specific reason to pass an argument to the constructor? We can use name method of Enum to get the string representation which will default to "BUG" and so on.
There was a problem hiding this comment.
The name method always returns the name in uppercase and is not really changeable. Using a String would allow us to change the name(the String) in the future. Furthermore, printing these is way easier because you don't need a lot of String manipulations. For example, you would print Security_Hotspot more likely than SECURITY_HOTSPOT. Converting SECURITY_HOTSPOT to a user-friendly, readable version requires unnecessary complex logic.
There was a problem hiding this comment.
The name method always returns the name in uppercase and is not really changeable.
Sounds good.
Furthermore, printing these is way easier because you don't need a lot of String manipulations
If it is supposed to be an output for user, it is better to name it toString than getName.
| /** | ||
| * Returns the name of the rule type. A rule type is a category of rules, such as "Bug", | ||
| * "Vulnerability". | ||
| */ |
There was a problem hiding this comment.
This is sufficient, I believe.
Currently, the RuleType enum is used in alot of places. But there could exist more categories of bad smells than the 3 sonar ones. Using an interface in the code allows adding new categories easier, e.g., from other analyzers, without constantly changing the enum.