rspec/rules/S3688/cobol/rule.adoc
Fred Tingaud 51369b610e
Make sure that includes are always surrounded by empty lines (#2270)
When an include is not surrounded by empty lines, its content is inlined
on the same line as the adjacent content. That can lead to broken tags
and other display issues.
This PR fixes all such includes and introduces a validation step that
forbids introducing the same problem again.
2023-06-22 10:38:01 +02:00

52 lines
858 B
Plaintext

== Why is this an issue?
This rule allows banning some modules.
=== Noncompliant code example
With ``++moduleName++`` configured with ``++[a-zA-Z-]*UT123[a-zA-Z]*++``:
[source,cobol]
----
CALL UT123.
CALL UT123L.
CALL UT123-L.
CALL WS-UT123.
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Remove the use of this forbidden module. Use {replacementModuleName} instead.
=== Parameters
.moduleName
****
Name of the forbidden module. Use a regex to forbid more widely multiple modules sharing the same root name.
****
.replacementModuleName
****
Name of the module to use as a replacement of the forbidden one.
****
include::../highlighting.adoc[]
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]