Skip to content

AI: Allow a function to be referenced in PS4 #3386

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dotysan wants to merge 1 commit into
base: master
Choose a base branch
from
+28 −2
Open

AI: Allow a function to be referenced in PS4 #3386

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 28 additions & 2 deletions src/ShellCheck/Analytics.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5049,6 +5049,8 @@ prop_checkCommandIsUnreachable2 = verify checkCommandIsUnreachable "die() { exit
prop_checkCommandIsUnreachable3 = verifyNot checkCommandIsUnreachable "foo; bar || exit; baz"
prop_checkCommandIsUnreachable4 = verifyNot checkCommandIsUnreachable "f() { foo; }; # Maybe sourced"
prop_checkCommandIsUnreachable5 = verify checkCommandIsUnreachable "f() { foo; }; exit # Not sourced"
prop_checkCommandIsUnreachable10 = verifyNot checkCommandIsUnreachable "f() { :; }; PS4='$(f)'; exit"
prop_checkCommandIsUnreachable11 = verifyNot checkCommandIsUnreachable "f() { :; }; PS4='`f`'; exit"
checkCommandIsUnreachable params t =
case t of
T_Pipeline {} -> sequence_ $ do
Expand All @@ -5058,10 +5060,12 @@ checkCommandIsUnreachable params t =
guard . not $ isSourced params t
guard . not $ any (\t -> isUnreachable t || isUnreachableFunction t) $ NE.drop 1 $ getPath (parentMap params) t
return $ info (getId t) 2317 "Command appears to be unreachable. Check usage (or ignore if invoked indirectly)."
T_Function id _ _ _ _ ->
T_Function id _ _ name _ ->
when (isUnreachableFunction t
&& (not . any isUnreachableFunction . NE.drop 1 $ getPath (parentMap params) t)
&& (not $ isSourced params t)) $
&& not (isSourced params t)
&& not (ps4CallsFunction name)
) $
info id 2329 "This function is never invoked. Check usage (or ignored if invoked indirectly)."
_ -> return ()
where
Expand All @@ -5075,6 +5079,28 @@ checkCommandIsUnreachable params t =
state <- CF.getIncomingState cfga (getId t)
return . not $ CF.stateIsReachable state

ps4CallsFunction :: String -> Bool
ps4CallsFunction name =
any (any mentionsTok) ps4Values
where
ps4Values :: [[Token]]
ps4Values =
[ values
| Assignment (_, _, "PS4", DataString (SourceFrom values)) <- variableFlow params
]

mentionsTok :: Token -> Bool
mentionsTok tok
| isCommandSubstitution tok =
getCommandNameFromExpansion tok == Just name
| otherwise = case tok of
T_NormalWord _ parts -> any mentionsTok parts
T_DoubleQuoted _ parts -> any mentionsTok parts
T_DollarDoubleQuoted _ parts -> any mentionsTok parts
T_SingleQuoted _ s -> s `matches` mkRegex ("\\$\\([[:space:]]*" ++ name ++ "([[:space:]]|\\)|$)")
|| s `matches` mkRegex ("`[[:space:]]*" ++ name ++ "([[:space:]]|`|$)")
_ -> False


prop_checkOverwrittenExitCode1 = verify checkOverwrittenExitCode "x; [ $? -eq 1 ] || [ $? -eq 2 ]"
prop_checkOverwrittenExitCode2 = verifyNot checkOverwrittenExitCode "x; [ $? -eq 1 ]"
Expand Down