rspec/rules/S2701/php/rule.adoc
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

40 lines
1017 B
Plaintext

== Why is this an issue?
Instead of using boolean literals or _null_ in an equality with _assertSame()_ or _assertEquals()_, it is recommended to rely on the alternative functions _assertTrue()_, _assertFalse()_, assertNull(), and _assertNotNull()_.
=== Noncompliant code example
[source,php]
----
assertEquals(true, $x); // Noncompliant {{Use assertTrue() instead.}}
assertNotEquals(false, $x); // Noncompliant {{Use assertTrue() instead.}}
assertSame(null, $x); // Noncompliant {{Use assertNull() instead.}}
assertNotSame(true, $x); // Noncompliant {{Use assertFalse() instead.}}
----
=== Compliant solution
[source,php]
----
assertTrue($x); // Compliant
assertFalse($x); // Compliant
assertNull($x); // Compliant
assertNotNull($x); // Compliant
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]