rspec/rules/S3853/xml/rule.adoc

57 lines
813 B
Plaintext
Raw Normal View History

== Why is this an issue?
2021-04-28 16:49:39 +02:00
Sharing naming conventions allows teams to collaborate efficiently. This rule checks that type names match a provided regular expression.
=== Noncompliant code example
2021-04-28 16:49:39 +02:00
With the default regular expression:
2022-02-04 17:28:24 +01:00
[source,xml]
2021-04-28 16:49:39 +02:00
----
<xs:complexType name="fruit"> <!-- Noncompliant -->
...
</xs:complexType>
----
=== Compliant solution
2021-04-28 16:49:39 +02:00
2022-02-04 17:28:24 +01:00
[source,xml]
2021-04-28 16:49:39 +02:00
----
<xs:complexType name="fruitType">
...
</xs:complexType>
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Rename this type to match the regular expression: ${format}.
=== Parameters
.format
****
----
^[a-z]+([A-Z][a-z0-9]+)*Type$
----
Regular expression used to check types against
****
=== Highlighting
name value
endif::env-github,rspecator-view[]