2023-05-03 11:06:20 +02:00
== Why is this an issue?
2020-06-30 10:16:44 +02:00
Sharing some naming conventions is a key point to make it possible for a team to efficiently collaborate. This rule allows to check that all protocol names match a provided regular expression.
2023-05-03 11:06:20 +02:00
=== Noncompliant code example
2020-06-30 10:16:44 +02:00
2021-01-27 13:42:22 +01:00
With the default regular expression ``++^[A-Z][a-zA-Z0-9]*$++``:
2020-06-30 14:49:38 +02:00
2022-02-04 17:28:24 +01:00
[source,swift]
2020-06-30 10:16:44 +02:00
----
public protocol myProtocol {...} // Noncompliant
----
2023-05-03 11:06:20 +02:00
=== Compliant solution
2020-06-30 10:16:44 +02:00
2022-02-04 17:28:24 +01:00
[source,swift]
2020-06-30 10:16:44 +02:00
----
public protocol MyProtocol {...}
----
2021-06-02 20:44:38 +02:00
2021-06-03 09:05:38 +02:00
ifdef::env-github,rspecator-view[]
2021-09-20 15:38:42 +02:00
'''
== Implementation Specification
(visible only on this page)
2023-05-25 14:18:12 +02:00
=== Message
Rename protocol ${name} to match the regular expression ${format}
=== Parameters
.format
****
_String_
----
^[A-Z][a-zA-Z0-9]*$
----
Regular expression used to check the protocol names against.
****
2021-09-20 15:38:42 +02:00
2021-06-08 15:52:13 +02:00
'''
2021-06-02 20:44:38 +02:00
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
2021-06-03 09:05:38 +02:00
endif::env-github,rspecator-view[]