16f6c0aecf
Inline adoc files when they are included exactly once. Also fix language tags because this inlining gives us better information on what language the code is written in.
46 lines
768 B
Plaintext
46 lines
768 B
Plaintext
== Why is this an issue?
|
|
|
|
Shared coding conventions allow teams to collaborate efficiently. This rule checks that all enumeration member names match a provided regular expression.
|
|
|
|
=== Noncompliant code example
|
|
|
|
With default provided regular expression: ``++^[a-z][a-zA-Z0-9]*$++``
|
|
|
|
[source,swift]
|
|
----
|
|
enum SomeEnumeration {
|
|
case SomeMember // Non-Compliant
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,swift]
|
|
----
|
|
enum SomeEnumeration {
|
|
case someMember
|
|
}
|
|
----
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
=== Parameters
|
|
|
|
.format
|
|
****
|
|
|
|
----
|
|
^[a-z][a-zA-Z0-9]*$
|
|
----
|
|
|
|
Regular expression used to check the enumeration value names against.
|
|
****
|
|
|
|
|
|
endif::env-github,rspecator-view[]
|