SC2115 fires when it is statically verifyable that the variable cannot be empty

Question

SC2115 fires when it is statically verifyable that the variable cannot be empty

benblank opened this issue 2 months ago · comments

For bugs

Rule Id: SC2115
My shellcheck version: 0.10.0
The rule's wiki page does not already cover this (e.g. https://shellcheck.net/wiki/SC2115)
I tried on https://www.shellcheck.net/ and verified that this is still a problem on the latest commit

I had assumed this rule would work similarly to SC2086, in that it wouldn't trigger if the variable's declaration were available and could not lead to the described problem occurring. In the example below, STEAMROOT is declared within the script being checked and cannot be empty even if HOME is.

Here's a snippet that shows the problem:

#!/bin/sh

STEAMROOT=$HOME/.local/share/Steam

rm -rf "$STEAMROOT/"*

Here's what shellcheck currently says:

Line 5:
rm -rf "$STEAMROOT/"*
       ^-- SC2115 (warning): Use "${var:?}" to ensure this never expands to /* .

Here's what I expected to see:

No issues detected!

ale5000 · Answer 1 · Sun Apr 21 2024 07:59:18 GMT+0800 (China Standard Time)

Personally I think it is always advisable to use "${var:?}".

Put this case:

STEAMROT=$HOME/.local/share/Steam
rm -rf "$STEAMROOT/"*

In this example there is a missing letter in the variable declaration, and this cause the second commands to wipe all your files.

Ben Blank · Answer 2 · Mon Apr 22 2024 02:15:50 GMT+0800 (China Standard Time)

There's definitely a case to be made for safe habits. SC2086 has a corresponding optional/"strict" check, SC2248. Potentially, an optional version of this check could be useful, as well? I do think it would be nice to take advantage of the extra information by default.

In the end, I certainly don't feel that the current behavior is bad, simply that it could perhaps be refined. This issue is really just the result of having been surprised by SC2115's behavior compared to SC2086. 🙂

As for the typo, that would still trigger SC2034 for the unused variable and SC2153 for the undefined variable, both of which I feel are more relevant to having made a typo than not knowing whether the misspelled variable is empty.