Rework naming rules to match intellij inspections #569
Conversation
| active: true | ||
| constantPattern: '^([A-Z_]*|serialVersionUID)$' | ||
| propertyPattern: '[A-Za-z][_A-Za-z0-9]*' | ||
| TopLevelPropertyNaming: |
There was a problem hiding this comment.
I like the granularity for the naming rules.
|
|
||
| override val issue = Issue(javaClass.simpleName, | ||
| Severity.Style, | ||
| "Constants names should follow the naming convention set in the projects configuraiton.", | ||
| "Constants inside objects should follow the naming convention set in the projects configuration.", |
There was a problem hiding this comment.
It might be a bit unclear what the convention set looks like for the reader of this message. What do you think?
There was a problem hiding this comment.
Sorry, I don't get what you mean :)?
| message = "Private top level property names should match the pattern: $propertyPattern")) | ||
| } | ||
| } else { | ||
| if (!property.identifierName().matches(propertyPattern)) { |
There was a problem hiding this comment.
Should detekt's rule configuration really differentiate between private and non-private top level properties?
There was a problem hiding this comment.
IntelliJ does, so I also implemented this. If having only top level declarations inside a file, it could be handy to name things with _ ^^
| import org.assertj.core.api.Assertions | ||
| import org.junit.jupiter.api.Test | ||
|
|
||
| class NamingConventionCustomPatternTest { |
There was a problem hiding this comment.
Splitting up the these test cases is a good idea!
| // valid: underscore only allowed for private vars | ||
| private val _variable = 5 | ||
| val _variable2 = 5 // invalid | ||
|
|
There was a problem hiding this comment.
I think all these test cases should be in separate test cases and not in one big file. This could lead to problems discussed in #527
There was a problem hiding this comment.
I think after this PR this file and NamingConventionSpec is not needed anymore, as all cases/rules have their own spec class then ^^
|
Merged manually. |
Ok, the
serialVersionUIDname is now supported by default.