From 544047c5afa19fb1551ba4f0d4f56ef34746e391 Mon Sep 17 00:00:00 2001
From: Vidar Holen <spam@vidarholen.net>
Date: Sun, 30 Jun 2019 18:26:41 -0700
Subject: [PATCH] Warn about ending double quotes just to make $ literal
---
CHANGELOG.md | 1 +
src/ShellCheck/Parser.hs | 27 ++++++++++++++++++++++++---
2 files changed, 25 insertions(+), 3 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index e074894..5ea2768 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -19,6 +19,7 @@
- SC2246: Warn if a shebang's interpreter ends with /
- SC2245: Warn that Ksh ignores all but the first glob result in `[`
- SC2243/SC2244: Suggest using explicit -n for `[ $foo ]` (optional)
+- SC1135: Suggest not ending double quotes just to make $ literal
### Changed
- If a directive or shebang is not specified, a `.bash/.bats/.dash/.ksh`
diff --git a/src/ShellCheck/Parser.hs b/src/ShellCheck/Parser.hs
index 059f03b..445d43b 100644
--- a/src/ShellCheck/Parser.hs
+++ b/src/ShellCheck/Parser.hs
@@ -1524,10 +1524,10 @@ ensureDollar =
readNormalDollar = do
ensureDollar
- readDollarExp <|> readDollarDoubleQuote <|> readDollarSingleQuote <|> readDollarLonely
+ readDollarExp <|> readDollarDoubleQuote <|> readDollarSingleQuote <|> readDollarLonely False
readDoubleQuotedDollar = do
ensureDollar
- readDollarExp <|> readDollarLonely
+ readDollarExp <|> readDollarLonely True
prop_readDollarExpression1 = isOk readDollarExpression "$(((1) && 3))"
@@ -1689,11 +1689,32 @@ readVariableName = do
rest <- many variableChars
return (f:rest)
-readDollarLonely = do
+
+prop_readDollarLonely1 = isWarning readNormalWord "\"$\"var"
+prop_readDollarLonely2 = isWarning readNormalWord "\"$\"\"var\""
+prop_readDollarLonely3 = isOk readNormalWord "\"$\"$var"
+prop_readDollarLonely4 = isOk readNormalWord "\"$\"*"
+prop_readDollarLonely5 = isOk readNormalWord "$\"str\""
+readDollarLonely quoted = do
start <- startSpan
char '$'
id <- endSpan start
+ when quoted $ do
+ isHack <- quoteForEscape
+ when isHack $
+ parseProblemAtId id StyleC 1135
+ "Prefer escape over ending quote to make $ literal. Instead of \"It costs $\"5, use \"It costs \\$5\"."
return $ T_Literal id "$"
+ where
+ quoteForEscape = option False $ try . lookAhead $ do
+ char '"'
+ -- Check for "foo $""bar"
+ optional $ char '"'
+ c <- anyVar
+ -- Don't trigger on [[ x == "$"* ]] or "$"$pattern
+ return $ c `notElem` "*$"
+ anyVar = variableStart <|> digit <|> specialVariable
+
prop_readHereDoc = isOk readScript "cat << foo\nlol\ncow\nfoo"
prop_readHereDoc2 = isNotOk readScript "cat <<- EOF\n cow\n EOF"