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.
56 lines
1.1 KiB
Plaintext
56 lines
1.1 KiB
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
[source,php]
|
|
----
|
|
if ($x > 0) // Noncompliant
|
|
doTheThing();
|
|
doTheOtherThing(); // Was the intent to call this function unconditionally?
|
|
----
|
|
|
|
It becomes even more confusing and bug-prone if lines get commented out.
|
|
|
|
[source,php]
|
|
----
|
|
if ($x > 0) // Noncompliant
|
|
// doTheThing();
|
|
doTheOtherThing(); // Was the intent to call this function conditionally?
|
|
----
|
|
|
|
Indentation alone or together with curly braces makes the intent clear.
|
|
|
|
[source,php]
|
|
----
|
|
if ($x > 0)
|
|
doTheThing();
|
|
doTheOtherThing(); // Clear intent to call this function unconditionally
|
|
|
|
// or
|
|
|
|
if ($x > 0) {
|
|
doTheThing();
|
|
}
|
|
doTheOtherThing(); // Clear intent to call this function unconditionally
|
|
----
|
|
|
|
This rule raises an issue if the line controlled by a conditional has the same indentation as the conditional and is not enclosed in curly braces.
|
|
|
|
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[]
|