rspec/rules/S2479/plsql/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

52 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[]