rspec/rules/S114/swift/rule.adoc

52 lines
923 B
Plaintext
Raw Normal View History

== 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.
=== 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]*$++``:
2022-02-04 17:28:24 +01:00
[source,swift]
2020-06-30 10:16:44 +02:00
----
public protocol myProtocol {...} // Noncompliant
----
=== 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 {...}
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== 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.
****
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]