Skip to content

Commit

Permalink
Modify rule S100: add language JCL (#3723)
Browse files Browse the repository at this point in the history
* Add jcl to rule S100

* Provide JCL details

* Address review comment

---------

Co-authored-by: rudy-regazzoni-sonarsource <rudy-regazzoni-sonarsource@users.noreply.github.com>
Co-authored-by: Rudy Regazzoni <110470341+rudy-regazzoni-sonarsource@users.noreply.github.com>
  • Loading branch information
3 people authored Mar 12, 2024
1 parent 150702c commit a2241c3
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 1 deletion.
3 changes: 3 additions & 0 deletions rules/S100/jcl/metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"title": "Procedure names should comply with a naming convention"
}
36 changes: 36 additions & 0 deletions rules/S100/jcl/rule.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
== Why is this an issue?

Shared naming conventions allow teams to collaborate efficiently.

This rule raises an issue when a procedure name does not match a provided regular expression.

For example, with the default provided regular expression ``++^[A-Z][A-Z0-9]*$++``, the procedure:

[source,jcl]
----
//* Noncompliant
//$PROC1 PROC
----

should be renamed to

[source,jcl]
----
//PROC1 PROC
----

ifdef::env-github,rspecator-view[]

'''
== Implementation Specification
(visible only on this page)

include::../message.adoc[]

'''
== Comments And Links
(visible only on this page)

include::../comments-and-links.adoc[]

endif::env-github,rspecator-view[]
2 changes: 1 addition & 1 deletion rules/S100/message.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
=== Message

Rename [method|function|subroutine] "XXXX" to match the regular expression ${format}.
Rename [method|function|subroutine|procedure] "XXXX" to match the regular expression ${format}.

0 comments on commit a2241c3

Please sign in to comment.