如何在不导致脚本失败的情况下满足 shellcheck？

Question

我目前正在测试 GitHub 操作，快速入门解释了如何将超级 linter 添加到 repo，这是在整个 repo 中应用 linting 的一种简单方法 - 我喜欢这个想法，所以我将它添加到我的 repo 中，其中一个 linter它适用的是 shellcheck，它在我的 shell 脚本之一上引发了一些错误。

shell 脚本问题docker run ：

docker run --rm \
    "${INTERACTIVE_MODE_FLAG}" \
    ${EXTRA_DOCKER_ARGS} \
    "${IMAGE}":"${IMAGE_VERSION}" "$@"

Shellcheck 正在抛出SC2086 双引号以防止在${EXTRA_DOCKER_ARGS}上出现通配符和分词。 我可以通过将代码更改为：

docker run --rm \
    "${INTERACTIVE_MODE_FLAG}" \
    "${EXTRA_DOCKER_ARGS}" \
    "${IMAGE}":"${IMAGE_VERSION}" "$@"

（注意将${EXTRA_DOCKER_ARGS}用引号括起来）

docker：参考格式无效

如果我将set -x添加到脚本的顶部，它会显示问题所在：

+ docker 运行 --rm -it '' myimage:mytag
docker：参考格式无效。

请注意如何将两个额外的撇号添加到命令中。

我的问题很简单......我该如何解决这个问题？ 我想消除 Shellcheck 错误，但仍然有一个正常运行的脚本。

Answer 1

您的代码使用字符串作为列表，这种概念上的不匹配导致了警告。 这是一个真正的问题，你应该解决它。

您应该：

A. 使 EXTRA_DOCKER_ARGS 成为一个列表开始。

或者

B. 将 EXTRA_DOCKER_ARGS 保留为字符串，并考虑如何将其拆分为 arguments（在空格上？逐行？shell 引用了 arguments？）。 这需要符合设置变量的人的期望。

---

对于 A，您可以将变量简化为数组并相应地展开：

EXTRA_DOCKER_ARGS=()
docker run --rm \
    "${INTERACTIVE_MODE_FLAG}" \
    "${EXTRA_DOCKER_ARGS[@]}" \
    "${IMAGE}":"${IMAGE_VERSION}" "$@"

---

对于 B，您可以例如将其视为 shell 引用的字符串，需要通过 eval 扩展：

extras=()
eval "extras+=( $EXTRA_DOCKER_ARGS )"
docker run --rm \
    "${INTERACTIVE_MODE_FLAG}" \
    "${extras[@]}" \
    "${IMAGE}":"${IMAGE_VERSION}" "$@"

---

如果你不修复这个问题，继续依赖隐式分词，那么你将无法传递额外的包含空格的 arguments，例如-v "$HOME/My Documents:/mnt"

Answer 2

在不禁用 shellcheck 警告的情况下：

#!/usr/bin/env bash

# Word split EXTRA_DOCKER_ARGS into extra_docker_args_array
read -r -a extra_docker_args_array <<<"$EXTRA_DOCKER_ARGS"

docker run --rm \
    "$INTERACTIVE_MODE_FLAG" \
    "${extra_docker_args_array[@]}" \
    "$IMAGE:$IMAGE_VERSION" "$@"

Answer 3

看起来像手册页https://www.mankier.com/1/shellcheck描述了覆盖错误的方法。

忽略某些错误：

shellcheck --exclude SC2086 file.sh

如果您可以配置 shellcheck arguments 以这种方式运行它应该修复它。 通常我不喜欢覆盖 linters，但在这种情况下，查看该变量的作用，我看不到解决方法。 不能对 docker 引用一堆 args。 它们确实需要作为单独的参数传递。

Answer 4

刚刚决定使用禁用 shellcheck

# shellcheck disable=SC2086
docker run --rm \
    "${INTERACTIVE_MODE_FLAG}" \
    ${EXTRA_DOCKER_ARGS} \
    "${IMAGE}":"${IMAGE_VERSION}" "$@"

更新。 我认为@that-other-guy 的答案更好，所以我改了。