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

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

简介

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

ShellCheck 的目标是:

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

项目地址是:

https://github.com/koalaman/shellcheck

使用方法

通过网页官网

可以将 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 等。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 211,948评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,371评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,490评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,521评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,627评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,842评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,997评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,741评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,203评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,534评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,673评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,339评论 4 330
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,955评论 3 313
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,770评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,000评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,394评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,562评论 2 349

推荐阅读更多精彩内容