rspec/rules/S1642/swift/rule.adoc

45 lines
762 B
Plaintext
Raw Permalink Normal View History

== Why is this an issue?
2021-01-27 13:42:22 +01:00
Sharing some naming conventions enables teams to collaborate more efficiently. This rule checks that all ``++struct++`` names match a provided regular expression.
2020-06-30 12:47:33 +02:00
2021-02-02 15:02:10 +01:00
2020-06-30 12:47:33 +02:00
Using the default regular expression: "^[A-Z][a-zA-Z0-9]*$"
=== Noncompliant code example
2020-06-30 12:47:33 +02:00
2022-02-04 17:28:24 +01:00
[source,swift]
2020-06-30 12:47:33 +02:00
----
struct my_struct {
var one : Int
var two : Int
}
----
=== Compliant solution
2020-06-30 12:47:33 +02:00
2022-02-04 17:28:24 +01:00
[source,swift]
2020-06-30 12:47:33 +02:00
----
struct MyStruct {
var one : Int
var two : Int
}
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
include::../parameters.adoc[]
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]