rspec/rules/S3845/xml/rule.adoc
Fred Tingaud 16f6c0aecf
Inline adoc when include has no additional value (#1940)
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.
2023-05-25 14:18:12 +02:00

57 lines
816 B
Plaintext

== Why is this an issue?
Shared naming conventions allow teams to collaborate efficiently. This rule checks that all element names match a provided regular expression.
=== Noncompliant code example
With the default regular expression:
[source,xml]
----
<xs:element name="Fruit"> <!-- Noncompliant -->
...
</xs:element>
----
=== Compliant solution
[source,xml]
----
<xs:element name="fruit">
...
</xs:element>
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Rename this element/attribute to match the regular expression: ${format}
=== Parameters
.format
****
----
^[a-z]+([A-Z][a-z0-9]+)*$
----
Regular expression used to check element names against.
****
=== Highlighting
name value
endif::env-github,rspecator-view[]