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.
53 lines
1.1 KiB
Plaintext
53 lines
1.1 KiB
Plaintext
== Why is this an issue?
|
|
|
|
New lines and control characters can be injected in the source code by bad manipulations. Control characters aren't visible to maintainers, so whether or not they are actually wanted should be double-checked. Note that this rule can optionally also report violations on literals containing the tabulation character.
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,sql]
|
|
----
|
|
SET SERVEROUTPUT ON
|
|
|
|
BEGIN
|
|
/* Non-Compliant */ DBMS_OUTPUT.PUT_LINE('Hello
|
|
world!');
|
|
|
|
DBMS_OUTPUT.PUT_LINE('Hello'); -- Compliant, this is preferred
|
|
DBMS_OUTPUT.PUT_LINE('world!');
|
|
END;
|
|
/
|
|
----
|
|
|
|
=== Exceptions
|
|
|
|
By default no issue will be raised on tabulation characters. This exception can be disabled.
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
=== Parameters
|
|
|
|
.allowTabulations
|
|
****
|
|
|
|
----
|
|
true
|
|
----
|
|
|
|
'true' to allow tabulation characters in literals, 'false' otherwise
|
|
****
|
|
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|