当源文件代表脚本顶部的变量时，为什么 shellcheck 会失败？

Question

Ubuntu 16.04
Bash 4.3.48

当源文件代表脚本顶部的$variables时，为什么shellcheck会失败？

这是一个简单的脚本：

#!/bin/bash

. .sourcefile

echo "Today is ${day}."

这是我的源文件：

day="Monday"

这是shellcheck的回复：

me@myserver:~$ shellcheck start.sh

In start.sh line 5:
echo "Today is ${day}."
               ^-- SC2154: day is referenced but not assigned.

有没有办法让shellcheck知道$variables在源文件中？

---

这是我在 Ubuntu 16.04 上完成这项工作的方法

@Dash-o 解释了以下过程：

首先，在源文件声明上方的行中添加源指令，如下所示：
# shellcheck source=/path/to/sourcefile

#!/bin/bash

# shellcheck source=./.sourcefile
. .sourcefile

echo "Today is ${day}."

接下来，在脚本之前使用-x选项执行shellcheck ，如下所示：
shellcheck -x start.sh

me@myserver:~$ shellcheck -x start.sh

使用-x选项时， shellcheck将遵循直接在source 指令下方声明的源文件。 当我执行命令时，收到以下错误：

me@myserver:~$ shellcheck -x start.sh
unrecognized option `-x'

Usage: shellcheck [OPTIONS...] FILES...
  -e CODE1,CODE2..  --exclude=CODE1,CODE2..  exclude types of warnings
  -f FORMAT         --format=FORMAT          output format
  -s SHELLNAME      --shell=SHELLNAME        Specify dialect (bash,sh,ksh)
  -V                --version                Print version information

@Bayou 提到我的操作系统需要更新版本的shellcheck 。 我检查了我的 Ubuntu 16.04 安装。 我的服务器有shellcheck 0.3.7，这是 Ubuntu 16.04 必须提供的最新版本，所以我从shellcheck开发人员那里获取了最新的二进制文件并安装了它。

me@myserver:~$ mkdir .work && cd .work
me@myserver:~/.work$ wget -q https://github.com/koalaman/shellcheck/releases/download/stable/shellcheck-stable.linux.x86_64.tar.xz
me@myserver:~/.work$ ls

shellcheck-stable.linux.x86_64.tar.xz

me@myserver:~/.work$ tar xvf shellcheck-stable.linux.x86_64.tar.xz

shellcheck-stable/README.txt
shellcheck-stable/LICENSE.txt
shellcheck-stable/shellcheck

me@myserver:~/.work$ sudo chown root: shellcheck-stable/shellcheck
me@myserver:~/.work$ sudo mv /usr/bin/shellcheck .
me@myserver:~/.work$ sudo mv shellcheck-stable/shellcheck /usr/bin/
me@myserver:~/.work$ cd ../
me@myserver:~$ rm -rf .work/
me@myserver:~$ shellcheck -V

ShellCheck - shell script analysis tool
version: 0.7.1
license: GNU General Public License, version 3
website: https://www.shellcheck.net

我运行命令shellcheck -x start.sh并收到零错误。

me@myserver:~$ shellcheck -x start.sh

然后我强迫shellcheck给我一些错误。 我在脚本末尾添加了cat $myVariable 。

me@myserver:~$ echo "cat \$myVariable" >> start.sh  
me@myserver:~$ cat start.sh
#!/bin/bash

# shellcheck source=./.sourcefile
. .sourcefile

echo "Today is ${day}."
cat $myVariable

我测试了我的理论，然后shellcheck跟踪了我的源文件并给了我预期的错误。

me@myserver:~$ shellcheck -x start.sh

In start.sh line 7:
cat $myVariable
    ^---------^ SC2154: myVariable is referenced but not assigned.
    ^---------^ SC2086: Double quote to prevent globbing and word splitting.

Did you mean:
cat "$myVariable"

For more information:
  https://www.shellcheck.net/wiki/SC2154 -- myVariable is referenced but not ...
  https://www.shellcheck.net/wiki/SC2086 -- Double quote to prevent globbing ...

然后我在没有-x选项的情况下执行了shellcheck并且令我惊讶的是我收到了以下错误：

me@myserver:~$ shellcheck start.sh

In start.sh line 4:
. .sourcefile
  ^---------^ SC1091: Not following: ./.sourcefile was not specified as input (see shellcheck -x).


In start.sh line 6:
echo "Today is ${day}."
               ^----^ SC2154: day is referenced but not assigned.


In start.sh line 7:
cat $myVariable
    ^---------^ SC2154: myVariable is referenced but not assigned.
    ^---------^ SC2086: Double quote to prevent globbing and word splitting.

Did you mean:
cat "$myVariable"

For more information:
  https://www.shellcheck.net/wiki/SC2154 -- day is referenced but not assigned.
  https://www.shellcheck.net/wiki/SC1091 -- Not following: ./.sourcefile was ...
  https://www.shellcheck.net/wiki/SC2086 -- Double quote to prevent globbing ...

所以shellcheck更新到最新版本并且没有-x选项，也会给你一个关于你在命令行上错过-x选项的错误。 所以我决定在我的 start.sh 中注释掉sourcefile 指令

me@myserver:~$ sed -i '3s/./#\ &/' start.sh
me@myserver:~$ cat start.sh
#!/bin/bash

# # shellcheck source=./.sourcefile
. .sourcefile

echo "Today is ${day}."
cat $myVariable

现在看看shellcheck是怎么想的

me@myserver:~$ shellcheck -x start.sh

In start.sh line 7:
cat $myVariable
    ^---------^ SC2154: myVariable is referenced but not assigned.
    ^---------^ SC2086: Double quote to prevent globbing and word splitting.

Did you mean:
cat "$myVariable"

For more information:
  https://www.shellcheck.net/wiki/SC2154 -- myVariable is referenced but not ...
  https://www.shellcheck.net/wiki/SC2086 -- Double quote to prevent globbing ...

哇啊啊啊所以我的简单脚本似乎真的不需要sourcefile 指令，或者 shellcheck 是否仍然看到sourcefile 指令被数字符号注释掉，因为数字符号已经启动了sourcefile 指令？ 因此，我完全删除了sourcefile 指令，并注释掉了最后一行引用未在源文件中分配的myVariable变量的内容。

me@myserver:~$ sed -i '3d' start.sh
me@myserver:~$ sed -i '$d' start.sh
me@myserver:~$ cat start.sh
#!/bin/bash

. .sourcefile

echo "Today is ${day}."  

现在看看shellcheck报告了什么：

me@myserver:~$ shellcheck -x start.sh

-x选项没有错误。 现在，为了检查在 Ubuntu 16.04 上使用最新版本的shellcheck的简单 shell 脚本的顶部是否不需要sourcefile 指令，我在没有-x选项的情况下执行了shellcheck 。

me@myserver:~$ shellcheck start.sh

In start.sh line 3:
. .sourcefile
  ^---------^ SC1091: Not following: .sourcefile was not specified as input (see shellcheck -x).


In start.sh line 5:
echo "Today is ${day}."
               ^----^ SC2154: day is referenced but not assigned.

For more information:
  https://www.shellcheck.net/wiki/SC2154 -- day is referenced but not assigned.
  https://www.shellcheck.net/wiki/SC1091 -- Not following: .sourcefile was no...

因此，简而言之，如果shellcheck没有跟踪您的源文件，请从开发人员的 github - ( https://github.com/koalaman/shellcheck ) 更新shellcheck并使用-x选项通知shellcheck有一个源文件可以跟踪所以：

shellcheck -x script.sh  

我希望这对某人有所帮助，因为这个网站每天都在帮助我！

Answer 1

Shellcheck 是一款 static 分析工具。 它不处理动态路径（基于变量或表达式）。 作为替代方案，请考虑添加 source 指令。

例子：

# shellcheck source=./lib.sh
source "$(find_install_dir)/lib.sh"

source= 指令告诉 shellcheck 动态生成的文件名的位置。 从问题来看，这应该是.sourcefile的（最有可能的，相对的）位置。

记录在https://github.com/koalaman/shellcheck/blob/master/shellcheck.1.md

Answer 2

我使用 shellcheck 0.4.4，它还说：

在 start.sh 第 2 行：。 "$(pwd)"/.sourcefile
^-- SC1090: 不能跟随非常量源。 使用指令指定位置。

这意味着您必须使用绝对路径，但较新的版本可能支持-P 。

如果您切换到非常量源，它将无法正常工作，因为.sourcefile需要一个 shebang 并且您必须使用-x添加此文件，如下所示：

shellcheck -x .sourcefile start.sh

它仍然会抱怨：

天="星期一"
^-- SC2034: day 似乎未使用。 验证或导出。

Answer 3

VSCode 修复

在 VSCode 中，你可以在 settings 中设置一个参数：

{
  "shellcheck.customArgs": ["-x"]
}

答案来自： https://unix.stackexchange.com/a/534690/231320

Answer 4

它比主要答案所暗示的更微妙。

如何正确修复SC1091 shellcheck 错误并让 shellcheck 遵循并检查您的源脚本

概括

把这三样东西放在一起：

1. 确保使用shellcheck -x path/to/script.sh 。
2. 确保使用# shellckeck source=path/to/sourced_script.sh指令注释。
3. 确保您在上述指令中使用的路径是相对于调用shellcheck -x path/to/script.sh时所在目录的路径。

细节

删除SC1091 (info): Not following: path/to/script.sh was not specified as input (see shellcheck -x). 错误，你需要所有这三样东西：

1. 调用shellcheck时添加-x ：

    # ok shellcheck -x path/to/script.sh # NOT ok shellcheck path/to/script.sh

2. 在关注区域上方添加适当的shellcheck指令注释：

   内部path/to/script.sh ：

    # ok # shellcheck source=bash/sound_bell_lib.sh. "$SCRIPT_DIRECTORY/sound_bell_lib.sh" # NOT ok. "$SCRIPT_DIRECTORY/sound_bell_lib.sh"

3. 确保您在shellcheck source=指令注释中使用的路径与您调用shellcheck时所在的路径相关！

   如果：

   1. 您的脚本位于~/dev/script.sh 。
   2. 您从~/dev/script.sh获取的脚本位于~/dev/script2.sh 。
   3. 运行 shellcheck 命令时，您位于~目录中。
   4. 您正在运行的 shellcheck 命令是shellcheck -x dev/script.sh

   然后，您必须使用的 shellcheck 指令路径是dev/script2.sh ，如下所示：

    # shellcheck source=dev/script2.sh. "$SCRIPT_DIRECTORY/script2.sh"

   但是，如果您在运行 shellcheck 命令时位于~/dev目录中，并且您正在运行的 shellcheck 命令是shellcheck -x script.sh ，那么您必须使用的 shellcheck 指令路径是./script2.sh ，或者只是script2.sh ，而是像这样：

    # shellcheck source=./script2.sh. "$SCRIPT_DIRECTORY/script2.sh"