51369b610e
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.
51 lines
868 B
Plaintext
51 lines
868 B
Plaintext
== Why is this an issue?
|
|
|
|
Shared coding conventions allow teams to collaborate efficiently. This rule checks that all variable names match the provided regular expression.
|
|
|
|
=== Noncompliant code example
|
|
|
|
With the default regular expression ``++[a-zA-Z]([a-zA-Z0-9_]*[a-zA-Z0-9])?++``:
|
|
|
|
[source,sql]
|
|
----
|
|
DECLARE
|
|
goodVariable PLS_INTEGER; -- Compliant
|
|
badVariable_ PLS_INTEGER; -- Non-Compliant
|
|
BEGIN
|
|
NULL;
|
|
END;
|
|
/
|
|
----
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
=== Message
|
|
|
|
Rename this variable to match the provided regular expression: xxx.
|
|
|
|
|
|
=== Parameters
|
|
|
|
.regexp
|
|
****
|
|
|
|
----
|
|
[a-zA-Z]([a-zA-Z0-9_]*[a-zA-Z0-9])?
|
|
----
|
|
|
|
The regular expression the name should match
|
|
****
|
|
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|