rspec/rules/S1125/swift/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

64 lines
1.4 KiB
Plaintext

== Why is this an issue?
Redundant boolean literals should be removed from expressions to improve readability.
=== Noncompliant code example
[source,swift]
----
if condition == true { /* ... */ } // Noncompliant
if condition != false { /* ... */ } // Noncompliant
if condition && true { /* ... */ } // Noncompliant
if condition || false { /* ... */ } // Noncompliant
doSomething(!false) // Noncompliant
doSomething(condition == true) // Noncompliant
v = condition ? true : false // Noncompliant
v = condition ? true : exp // Noncompliant
v = condition ? false : exp // Noncompliant
v = condition ? exp : true // Noncompliant
v = condition ? exp : false // Noncompliant
----
=== Compliant solution
[source,swift]
----
if condition { /* ... */ }
if condition { /* ... */ }
if condition { /* ... */ }
if condition { /* ... */ }
doSomething(true)
doSomething(condition)
v = condition
v = condition || exp
v = !condition && exp
v = !condition || exp
v = condition && exp
----
=== Exceptions
Expression statements are ignored.
[source,swift]
----
expect(value) == true // ignored
----
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[]