rspec/rules/S1192/apex/rule.adoc

62 lines
1.3 KiB
Plaintext
Raw Normal View History

== Why is this an issue?
2020-06-30 12:47:33 +02:00
include::../description.adoc[]
=== Noncompliant code example
2020-06-30 12:47:33 +02:00
2022-02-04 17:28:24 +01:00
[source,apex]
2020-06-30 12:47:33 +02:00
----
class A {
void doSomething(String msg) {
System.debug('string literal'); // Noncompliant - 'string literal' is duplicated 3 times
System.assertEquals(msg, 'string literal');
msg = 'string literal';
}
void doSomethingElse(String msg) {
System.debug('a'); // Compliant - literal 'a' has less than 5 characters and is excluded
System.assertEquals(msg, 'a');
msg = 'a';
}
}
----
=== Compliant solution
2020-06-30 12:47:33 +02:00
2022-02-04 17:28:24 +01:00
[source,apex]
2020-06-30 12:47:33 +02:00
----
class A {
static final String STRING_CONST = 'string literal';
void doSomething(String msg) {
System.debug(STRING_CONST); // Compliant
System.assertEquals(msg, STRING_CONST);
msg = STRING_CONST;
}
}
----
=== Exceptions
2020-06-30 12:47:33 +02:00
To prevent generating some false-positives, literals having 5 or less characters are excluded as well as literals containing only letters, digits and '_'.
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
include::../parameters.adoc[]
include::../highlighting.adoc[]
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]