rspec/rules/S1582/cobol/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

47 lines
867 B
Plaintext

== Why is this an issue?
Shared coding conventions allow teams to collaborate efficiently. This rule checks that logical file names conform to a provided regular expression.
=== Noncompliant code example
Given the regular expression ``++FILE-.*++``:
[source,cobol]
----
INPUT-OUTPUT SECTION.
FILE-CONTROL.
SELECT Y27MVTS ASSIGN TO S1 >Noncompliant
FILE STATUS IS FS-S1.
----
=== Compliant solution
[source,cobol]
----
INPUT-OUTPUT SECTION.
FILE-CONTROL.
SELECT FILE-X345 ASSIGN TO S1
FILE STATUS IS FS-S1.
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Parameters
.regexPatternString
****
A regular expression to specify the logical file naming convention
****
endif::env-github,rspecator-view[]