[Lint] Add a rule to detect that type declarations are not capitalized #587
Conversation
| /// `struct`, `class`, `enum` and `protocol` declarations should have a capitalized name. | ||
| /// | ||
| /// Lint: Types with un-capitalized names will yield a lint error. | ||
| public final class TypeNamesShouldBeCapitalized : SyntaxLintRule { |
There was a problem hiding this comment.
Can you also add ActorDeclSyntax, AssociatedTypeDeclSyntax, and TypeAliasDeclSyntax? I think that covers everything we'd want to apply this to.
There was a problem hiding this comment.
Sure! Will do! I went conservative initially to not over do it :)
| } | ||
|
|
||
| private func diagnoseNameConventionMismatch<T: DeclSyntaxProtocol>(_ type: T, name: TokenSyntax) { | ||
| if let firstChar = name.text.first, !firstChar.isUppercase { |
There was a problem hiding this comment.
Another thought occurred to me later; this will also flag type names that start with underscores, like _PrivateTypeButPublicForReasons. Do we want this rule to flag those too? Since those situations still come up in real-world code I don't know if we want to burden users with having to write // swift-format-ignore: TypeNamesShouldBeCapitalized above those.
Maybe strip off any sequence of leading underscores before checking the "first" character?
There was a problem hiding this comment.
You probably want to instead check that the first character does not change when uppercased to make it independent of the IdentifiersMustBeASCII rule.
There was a problem hiding this comment.
Addressed this is in 2fe98cf
…pes and typealias
|
|
||
| extension Finding.Message { | ||
| public static func capitalizeTypeName(name: String) -> Finding.Message { | ||
| let capitalized = name.prefix(1).uppercased() + name.dropFirst() |
There was a problem hiding this comment.
This won't produce the right result if there were leading underscores; if someone used _foo or __foo, I think we'd want to recommend _Foo or __Foo to them.
Unfortunately the tests don't catch this because they assert the diagnostic values rather than the generated message. (Something I'd like to fix one day....)
There was a problem hiding this comment.
Ah, I forgot to change that.
xedin
force-pushed
the
upstream-lint-type-capitalization-rule
branch
from
2fe98cf
to
be4493c
Compare
This is a first "convention" rule that checks that type names are capitalized.