ShellCheck-一款shell脚本检测工具

内容分享11小时前发布

0 3 0

什么？你还在用shell？

那你可要好好看看这个！

ShellCheck ，一款开源的静态分析工具，专门用于检查和分析 Shell 脚本中的常见错误和潜在问题。

1.工具功能特点：

• 静态分析工具：ShellCheck 是一个静态分析工具，用于检查 Shell 脚本中的语法错误、潜在的问题和最佳实践。

• 支持多种 Shell 语法：ShellCheck 支持 Bash、sh 和 ksh 等 Shell 脚本语言的语法检查。

• 提供详细提议：ShellCheck 会提供详细的提议和警告，协助用户改善 Shell 脚本的质量和可读性。

• 开源免费：ShellCheck 是开源的，并且免费使用，可以在多个平台上运行。

• 跨平台支持：ShellCheck 支持在 Linux、macOS、Windows 等多种操作系统上运行，并支持各种常见的 Shell 解释器，如 Bash、Dash、Zsh 等。

• 自定义规则：ShellCheck 允许用户定义自定义规则和过滤器，以适应特定项目或组织的需求。

2.支持的检查内容：

支持以下检查：

• Shell 脚本语法错误检查

• 变量使用和引用检查

• 命令替换和子shell检查

• 条件语句和循环结构检查

• 函数定义和使用检查

• 错误处理和退出状态检查

• 文件描述符和重定向检查

• 安全漏洞和最佳实践检查。

3.安装和使用：

• 可以通过包管理器安装，例如在 Debian/Ubuntu 系统上使用`apt-get install shellcheck`，在 macOS 上使用`brew install shellcheck`。

• 也可以从源码编译安装，第一克隆项目仓库，然后使用 Haskell 编译工具进行编译和安装。

• 使用 ShellCheck 检查脚本时，只需在命令行中运行`shellcheck <脚本名>`即可。

4.举个栗子：

举个栗子：

以下是一个简单的 Bash 脚本示例，其中包含了一些常见的错误，然后我将展示如何使用 ShellCheck 来检查这些错误。脚本示例：`example.sh`

#!/bin/bash

# 这是一个示例脚本，包含一些错误。

echo "Hello, World!"

# 错误的变量引用
var="Hello"
echo $var

# 错误的命令替换
result=$(ls /non/existent/directory)
echo "$result"

# 未使用的变量
unused_var="Unused"

# 错误的退出状态检查
if [ $? = 0 ]; then
    echo "Command succeeded"
else
    echo "Command failed"
fi

# 错误的循环
for i in {1..10}
do
    echo "Loop iteration: $i"
done

# 错误的函数定义
my_function() {
    echo "Function called"
}

my_function "argument"  # 错误的参数传递

使用 ShellCheck 检查脚本在命令行中，你可以使用以下命令来检查这个脚本：

shellcheck example.sh

ShellCheck 输出示例ShellCheck 可能会输出如下警告和提议：

example.sh:3:1: NOTE: 'var' is assigned a value that it never uses.
example.sh:6:1: WARNING: '$(...)' is used for command substitution. Consider 'command' or '$(command)' instead.
example.sh:9:9: ERROR: 'if [ $? -eq 0 ]' is more portable than 'if [ $? = 0 ]'. Use '==' for string comparison.
example.sh:14:10: ERROR: The for-loop variable 'i' is referenced but not assigned any value.
example.sh:19:21: WARNING: You're using a function you didn't declare with 'declare' or 'local'. It's probably a global. Are you sure?
example.sh:22:20: ERROR: Quote "argument" to prevent word splitting and globbing.

这些输出指出了脚本中的几个问题：• `var`变量被赋值但未使用。• 命令替换应该使用反引号或`$(command)`而不是`$(…)`。• 退出状态检查应该使用`-eq`而不是`=`，由于`=`是字符串比较运算符。• for 循环中的变量`i`没有被正确赋值。• 函数`my_function`没有使用`declare`或`local`声明，这可能导致全局变量问题。• 函数调用时参数应该被引号包围，以防止单词分割和通配符展开。通过这些检查，我们可以改善脚本，使其更加健壮和可移植。