rspec/rules/S1186/scala/rule.adoc
Rudy Regazzoni 1763d7fe2b
Modify S1186: Migrate to LayC - empty methods (#3285)
## Review

A dedicated reviewer checked the rule description successfully for:

- [ ] logical errors and incorrect information
- [ ] information gaps and missing content
- [ ] text style and tone
- [ ] PR summary and labels follow [the
guidelines](https://github.com/SonarSource/rspec/#to-modify-an-existing-rule)
2023-10-18 18:21:32 +02:00

64 lines
1.1 KiB
Plaintext

== Why is this an issue?
:operationName: method
include::../description.adoc[]
== How to fix it
=== Code examples
==== Noncompliant code example
[source,scala,diff-id=1,diff-type=noncompliant]
----
def shouldNotBeEmpty() = { // Noncompliant - method is empty
}
def notImplementedYet() = { // Noncompliant - method is empty
}
def willNeverBeImplemented() = { // Noncompliant - method is empty
}
def emptyOnPurpose() = { // Noncompliant - method is empty
}
----
==== Compliant solution
[source,scala,diff-id=1,diff-type=compliant]
----
def shouldNotBeEmpty() = {
doSomething()
}
def notImplementedYet() = {
throw new NotImplementedError()
}
def willNeverBeImplemented() = {
throw new UnsupportedOperationException()
}
def emptyOnPurpose() = {
// comment explaining why the method is empty
}
----
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[]