rspec/rules/S3973/tsql/rule.adoc

56 lines
1.4 KiB
Plaintext
Raw Normal View History

== Why is this an issue?
When the line immediately after a conditional has neither an enclosing `BEGIN...END` block nor indentation, the intent of the code is unclear and perhaps not what is executed. Additionally, such code is confusing to maintainers.
2020-06-30 12:48:39 +02:00
2022-02-04 17:28:24 +01:00
[source,sql]
2020-06-30 12:48:39 +02:00
----
IF @condition -- Noncompliant
EXEC doTheThing;
EXEC doTheOtherThing; -- Was the intent to call this function unconditionally?
2020-06-30 12:48:39 +02:00
----
It becomes even more confusing and bug-prone if lines get commented out.
2020-06-30 12:48:39 +02:00
2022-02-04 17:28:24 +01:00
[source,sql]
2020-06-30 12:48:39 +02:00
----
IF @condition -- Noncompliant
-- EXEC doTheThing;
EXEC doTheOtherThing; -- Was the intent to call this function conditionally?
2020-06-30 12:48:39 +02:00
----
Indentation alone or together with `BEGIN...END` block makes the intent clear.
2022-02-04 17:28:24 +01:00
[source,sql]
2020-06-30 12:48:39 +02:00
----
IF @condition
EXEC doTheThing;
EXEC doTheOtherThing; -- Clear intent to call this function unconditionally
2020-06-30 12:48:39 +02:00
IF @condition
BEGIN
EXEC doTheThing;
END;
EXEC doTheOtherThing; -- Clear intent to call this function unconditionally
2020-06-30 12:48:39 +02:00
----
This rule raises an issue if the line controlled by a conditional has the same indentation as the conditional and is not enclosed in a `BEGIN...END` block.
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[]