rspec/rules/S5831/java/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

48 lines
1.1 KiB
Plaintext

== Why is this an issue?
A ``++org.assertj.core.configuration.Configuration++`` will be effective only once you call ``++Configuration.apply()++`` or ``++Configuration.applyAndDisplay()++``.
This rule raises an issue when configurations are set without the appropriate call to apply them.
=== Noncompliant code example
[source,java]
----
Configuration configuration = new Configuration(); // Noncompliant, this configuration will not be applied.
configuration.setComparingPrivateFields(true);
----
=== Compliant solution
[source,java]
----
Configuration configuration = new Configuration();
configuration.setComparingPrivateFields(true);
configuration.applyAndDisplay();
// Alternatively: configuration.apply();
----
== Resources
* https://assertj.github.io/doc/#assertj-configuration[AssertJ configuration documentation]
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Apply this configuration with apply() or applyAndDisplay().
=== Highlighting
configuration identifier at declaration
endif::env-github,rspecator-view[]