rspec/rules/S101/go/rule.adoc
2022-02-04 16:28:24 +00:00

39 lines
899 B
Plaintext

Shared coding conventions allow teams to collaborate effectively. This rule allows to check that all class names match a provided regular expression.
The convention in go is to use mixedCaps rather than underscores. See https://golang.org/doc/effective_go.html#names[Go documentation] for the complete naming conventions.
Note that the casing of the first character determines if the type is exported or not.
== Noncompliant Code Example
With default provided regular expression ``++^[a-zA-Z][a-zA-Z0-9]*$++``:
[source,go]
----
type my_struct struct {...}
----
== Compliant Solution
[source,go]
----
type myStruct struct {...}
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]