首页 > 系统相关 >ShellCheck是一个静态分析工具

ShellCheck是一个静态分析工具

时间:2022-12-25 14:03:30浏览次数:60  
标签:str 静态 vim -- sh install syntastic 工具 ShellCheck

ShellCheck的功能

众所周知, 终端是Linux系统不可分割的一部分 以及我们在航站楼所做的一切背后, 有一个外壳,一个与操作系统本身交互的程序。 我们在终端中输入的每个命令最终都会由外壳程序解释,然后采取相应的行动。

UNIX shell不仅是命令解释器,而且还用作编程语言。 Shell作为一种编程语言,提供变量,控制流构造,预算和功能。

包含命令和Shell代码的文件称为Shell脚本。 因此,您可以使用Shell脚本为系统执行各种复杂的任务和自动化。

ShellCheck是一个静态分析工具,它显示bash / sh shell脚本中错误代码的警告和建议。

它可以以多种方式使用:通过将外壳脚本粘贴到在线编辑器中以从​​Web上进行​​运行,或者可以将其安装在系统上并从终端运行,然后将其与文本编辑器集成在一起,以及您的汇编或证明套件。

ShellCheck主要执行三件事:

  • 指出并解释典型的初学者语法问题,这些问题会导致shell发出错误的错误消息。
  • 指出并解释导致shell表现异常的典型中间层语义问题。
  • 它还指出了一些细微的警告,这些警告可能会导致本来可以运行的高级脚本在将来的情况下失败

在线使用

顾名思义,它提供了一个在线的检查地址​​https://www.shellcheck.net/​​,进入网址即可使用。
例如,你输入你的脚本内容:

#!/bin/sh
for n in {1..$RANDOM}
do
str=""
if (( n % 3 == 0 ))
then
str="fizz"
fi
if [ $[n%5] == 0 ]
then
str="$strbuzz"
fi
if [[ ! $str ]]
then
str="$n"
fi
echo "$str"
done

它会给出错误提示或者建议:

Line 2:
for n in {1..$RANDOM}
^-- SC2039: In POSIX sh, brace expansion is undefined.
^-- SC2039: In POSIX sh, RANDOM is undefined.

Line 5:
if (( n % 3 == 0 ))
^-- SC2039: In POSIX sh, standalone ((..)) is undefined.

Line 9:
if [ $[n%5] == 0 ]
^-- SC2039: In POSIX sh, $[..] in place of $((..)) is undefined.
^-- SC2007: Use $((..)) instead of deprecated $[..]
^-- SC2039: In POSIX sh, == in place of = is undefined.

Line 11:
str="$strbuzz"
^-- SC2154: strbuzz is referenced but not assigned.

Line 13:
if [[ ! $str ]]
^-- SC2039: In POSIX sh, [[ ]] is undefined.

怎么样,是不是很给力,每个可能的错误都提示了。新手写shell出现莫名的报错时,可以尝试使用奥。当然例子中很多并不是真的错误,而是某种写法不符合POSIX标准,这种情况也应该避免。

命令行使用

debian、ubuntu下:

apt-get install shellcheck

在RHEL、CentOS和Scientific Linux(官方:On EPEL based distros:).

yum -y install epel-release
sudo yum install ShellCheck

On Fedora based distros:

dnf install ShellCheck

On FreeBSD:

pkg install hs-ShellCheck

On macOS (OS X) with Homebrew:

brew install shellcheck

Or with MacPorts:

sudo port install shellcheck

On OpenBSD:

pkg_add shellcheck

On openSUSE

zypper in ShellCheck

Or use OneClickInstall - ​​https://software.opensuse.org/package/ShellCheck​

On Solus:

eopkg install shellcheck

On Windows (via ​​chocolatey​​):

C:\> choco install shellcheck

Or Windows (via ​​scoop​​):

C:\> scoop install shellcheck
  • 使用方法:
$ shellcheck myscript.sh

ShellCheck是一个静态分析工具_Shell

编辑器中使用

当然也可以把它安装到你熟悉的编辑器中,虽然它们本身都有语法高亮的功能,但是并没有直接的信息提示,安装shellcheck类工具,达到编写即提示的效果。

  • Emacs, 可以使用 Flycheck.
  • Sublime,可以使用 SublimeLinter.
  • Atom,可以使用 Linter.
  • vim ,可以使用ale或者syntastic

当然了,现代很多IDE都有这样检查功能,这里只说编辑器。

这里以syntastic为例,实际上它支持多种语言的语法检查。
安装过程:

1.安装pathogen.vim

$ mkdir -p ~/.vim/autoload ~/.vim/bundle && \
curl -LSso ~/.vim/autoload/pathogen.vim https://tpo.pe/pathogen.vim

并且在vimrc文件中配置以下内容:

execute pathogen#infect()

2.安装 Install syntastic

cd ~/.vim/bundle && \
git clone --depth=1 https://github.com/vim-syntastic/syntastic.git

3.测试安装情况
打开vim,输入以下内容

:Helptags

如果没有报错,说明安装正常。
在vimrc中配置以下内容:

set statusline+=%#warningmsg#
set statusline+=%{SyntasticStatuslineFlag()}
set statusline+=%*

let g:syntastic_always_populate_loc_list = 1
let g:syntastic_auto_loc_list = 1
let g:syntastic_check_on_open = 1

在goland编辑器中,集成了检测shell script脚本文件,提示安装shellcheck。

ShellCheck是一个静态分析工具_Shell_02

标签:str,静态,vim,--,sh,install,syntastic,工具,ShellCheck
From: https://blog.51cto.com/wyf1226/5968128

相关文章

  • 静态存储分配
    通常定义变量,编译器在编译时都可以根据该变量的类型知道所需内存空间的大小,从而系统在适当的时候为他们分配确定的存储空间。 在栈上创建。在执行函数时,函数内局部变量......
  • k8s本地联调工具kt-connect
    1、KtConnect简介KTConnect(KubernetesDeveloperTool)是轻量级的面向Kubernetes用户的开发测试环境治理辅助工具。其核心是通过建立本地到集群以及集群到本地......
  • 静态库与动态库的比较
    动态库只有在使用它的程序执行时才被链接使用,而不是将需要的部分直接编译入可执行文件中,并且一个动态库可以被多个程序使用故可称为共享库,而静态库将会整合到程序中,因此在......
  • 前端使用工具规范commit信息
    前言通过工具规范git提交信息也是工程化的一部分,在前端领域有一些工具为我们提供了相关功能,在这里做一下使用总结。commitlintcommitlint是什么?就像eslint用来检查js......
  • Kafka 常用工具脚本总结
    系统启动Kafka​​-daemon​​参数可以让Kafka在后台运行。kafka-server-start.sh-daemon/usr/local/kafka/config/server.properties复制指定JMX端口启动JMX的全......
  • 嵌入式LinuxC语言开发工具
    C语言产生的历史背景嵌入式Linux下C语言的开发环境嵌入式Linux下的编辑器vi嵌入式Linux下的编译器GCC嵌入式Linux下的调试器GDB嵌入式Linux下的工程管理器makeEclipse集成......
  • 华为云CodeArts Req需求管理工具,7大特性限时免费体验
    摘要:一图了解什么是华为云CodeArtsReq本文分享自华为云社区《​​华为云CodeArtsReq需求管理工具,7大特性限时免费体验​​》,作者:华为云PaaS服务小智。一图了解什么是华为......
  • 华为云CodeArts Req需求管理工具,7大特性限时免费体验
    摘要:一图了解什么是华为云CodeArtsReq本文分享自华为云社区《华为云CodeArtsReq需求管理工具,7大特性限时免费体验》,作者:华为云PaaS服务小智。一图了解什么是华为云Code......
  • Prometheus监控之检查工具Promtool简介
    一、简介Prometheus提供了一个非常有用的支持命令行工具promtool。这个小型的Golang二进制文件可用于快速执行包括查询指标、debug服务、对数据库进行检查等等故障排除操作......
  • Prometheus监控之检查工具Promtool check
    一、检查服务发现使用Promtool可以检查配置文件中的服务发现配置,防止配置错误导致程序无法启动,或者启动后无法正常发现内容。具体命令参数为promtoolcheckservice-disco......