Fred Tingaud 51369b610e
Make sure that includes are always surrounded by empty lines (#2270)
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.
2023-06-22 10:38:01 +02:00

45 lines
787 B
Plaintext

== Why is this an issue?
include::../description.adoc[]
include::../noncompliant.adoc[]
=== Exceptions
This rule will not raise an issue in either of these cases:
* When the condition is a single ``++const++`` of boolean value
[source,javascript]
----
const debug = false;
//...
if (debug) {
// Print something
}
----
* When the condition is the literal ``++0++``, ``++1++``, ``++true++`` or ``++false++``.
In these cases it is obvious the code is as intended.
include::../see.adoc[]
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
include::../highlighting.adoc[]
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]