rspec/rules/S4144/scala/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

67 lines
1.1 KiB
Plaintext

== Why is this an issue?
:func_name: method
include::../description.adoc[]
[source,scala,diff-id=1,diff-type=noncompliant]
----
class Circle(var radius: Int) {
def width_=(size: Int) {
radius = size / 2
updateShape()
}
def height_=(size: Int) { // Noncompliant: duplicates width_
radius = size / 2
updateShape()
}
def updateShape() = {...}
}
----
include::../inter.adoc[]
[source,scala,diff-id=1,diff-type=compliant]
----
class Circle(var radius: Int) {
def width_=(size: Int) {
diameter = size
}
def height_=(size: Int) {
diameter = size
}
def diameter_=(size: Int) { // Implementation is shared
radius = size / 2
updateShape()
}
def updateShape() = {...}
}
----
=== Exceptions
Methods with fewer than 2 statements are ignored.
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
include::../highlighting.adoc[]
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]