2.6 万 Star!Shell 脚本静态检测分析工具,支持 VSCode 和 Vim 等

开源前哨

【导语】:Shell 静态分析工具,无需运行就能发现 sh/bash 的语法、类型等错误。

简介

ShellCheck 是基于 GPLv3 协议的 shell 脚本静态分析工具,可以为 bash/sh shell 脚本提供警告和建议:

ShellCheck 的目标是:

  • 指出导致 shell 出现奇怪错误消息的典型初学者语法问题。
  • 指出导致 shell 行为异常和违反直觉的典型中级语义问题。
  • 指出可能导致高级用户的其他工作脚本在未来情况下失败的微妙警告、极端情况和错误。

项目地址是:

https://github.com/koalaman/s...

使用方法

通过网页官网

可以将 shell 脚本代码黏贴到官网检测页面上,可以即时获得反馈:

https://www.shellcheck.net

通过终端命令

可以下载 shellcheck,并在终端命令中执行 shellcheck 命令检测脚本:

通过编辑器

  • 在 VIM 中使用 ALE、Neomake、Syntastic 插件:

  • 在 Emacs 中使用 Flycheck、Flymake 插件:

  • 在 Sublime 中使用 SublimeLinter
  • 在 VSCode 中使用 vscode-shellcheck

在构建或测试平台中

ShellCheck 主要用于交互式使用,但也可以添加到构建或测试套件中,它使用了规范标准的退出代码,因此只需添加 shellcheck 命令作为流程的一部分即可。

例如在 Makefile 文件中:

check-scripts:
    # Fail if any of these files have warnings
    shellcheck myscripts/*.sh

或者在 Tarvis CI 的 .travis.yml 文件中:

script:
  # Fail if any of these files have warnings
  - shellcheck myscripts/*.sh

预先安装了 ShellCheck 并可用使用的服务和平台如下:

  • Travis CI
  • Codacy
  • Code Climate
  • Code Factor
  • CircleCI
  • Github(仅限 Linux)

安装

通过包管理器进行本地安装使最简单高效的方法

# 在带有 Cabal 的系统上(安装到~/.cabal/bin):
cabal update
cabal install ShellCheck

# 在具有 Stack(安装到~/.local/bin)的系统上:
stack update
stack install ShellCheck

# 在基于 Debian 的发行版上:
sudo apt install shellcheck

# 在基于 Arch Linux 的发行版上:
pacman -S shellcheck

# 在基于 Gentoo 的发行版上:
emerge --ask shellcheck

# 在基于 EPEL 的发行版上:
sudo yum -y install epel-release
sudo yum install ShellCheck

# 在基于 Fedora 的发行版上:
dnf install ShellCheck

# 在 FreeBSD 上:
pkg install hs-ShellCheck

# 在带有 Homebrew 的 macOS (OS X) 上:
brew install shellcheck

# 在 OpenBSD 上:
pkg_add shellcheck

# 在 openSUSE 上:
zypper in ShellCheck

# 在 Solus 上:
eopkg install shellcheck

# 在 Windows 上(通过Chocolatey):
C:\> choco install shellcheck

# 在 Windows 上(通过scoop):
C:\> scoop install shellcheck

# 通过 Docker:
docker run --rm -v "$PWD:/mnt" koalaman/shellcheck:stable myscript
# Or :v0.4.7 for that version, or :latest for daily builds

pre-commit

要通过 pre-commit 运行 ShellCheck ,添加 hooks 到 .pre-commit-config.yaml 文件中:

repos:
-   repo: https://github.com/koalaman/shellcheck-precommit
    rev: v0.7.2
    hooks:
    -   id: shellcheck
#       args: ["--severity=warning"]  # Optionally only show errors and warnings
开源前哨 日常分享热门、有趣和实用的开源项目。参与维护 10万+ Star 的开源技术资源库,包括:Python、Java、C/C++、Go、JS、CSS、Node.js、PHP、.NET 等。
阅读 238
84 声望
6 粉丝
0 条评论
84 声望
6 粉丝
文章目录
宣传栏