rspec/rules/S120/java/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

48 lines
695 B
Plaintext

== Why is this an issue?
include::../description.adoc[]
=== Noncompliant code example
With the default regular expression ``++^[a-z_]+(\.[a-z_][a-z0-9_]*)*$++``:
[source,java]
----
package org.exAmple; // Noncompliant
----
=== Compliant solution
[source,java]
----
package org.example;
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
=== Parameters
.format
****
----
^[a-z_]+(\.[a-z_][a-z0-9_]*)*$
----
Regular expression used to check the package names against.
****
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]