rspec/rules/S100/rpg/rule.adoc
2023-06-06 17:27:22 +02:00

68 lines
1008 B
Plaintext

== Why is this an issue?
Shared naming conventions allow teams to collaborate efficiently.
This rule raises an issue when a subroutine name does not match a provided regular expression.
For example, with the default provided regular expression ``++^SR[a-zA-Z0-9]*$++``, the following subroutines:
[source,rpg]
----
C XXXXX BEGSR
...
C ENDSR
----
[source,rpg]
----
/free
begsr yyyy;
endsr;
/end-free{code}
----
should be renamed to
[source,rpg]
----
C SR102 BEGSR
...
C ENDSR
----
[source,rpg]
----
/free
begsr SR103;
endsr;
/end-free
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
=== Parameters
.format
****
----
^SR[a-zA-Z0-9]*$
----
Regular expression used to check the subroutine names against
****
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]