rspec/rules/S1510/abap/rule.adoc

54 lines
729 B
Plaintext
Raw Normal View History

== Why is this an issue?
2021-04-28 16:49:39 +02:00
Naming conventions are an important tool in efficient team collaboration. This rule checks that all form names match a regular expression naming convention.
=== 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,abap]
2021-04-28 16:49:39 +02:00
----
FORM MyForm.
...
ENDFORM.
----
=== Compliant solution
2021-04-28 16:49:39 +02:00
2022-02-04 17:28:24 +01:00
[source,abap]
2021-04-28 16:49:39 +02:00
----
FORM MY_FORM.
...
ENDFORM.
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Rename form "XXXX" to match the regular expression ${format}
=== Parameters
.format
****
----
^([A-Z0-9_]*|[a-z0-9_]*)$
----
Regular expression used to check the form names against.
****
endif::env-github,rspecator-view[]