📜  vscode 更漂亮的显示错误 - Shell-Bash (1)

📅  最后修改于: 2023-12-03 15:35:37.941000             🧑  作者: Mango

vscode 更漂亮的显示错误 - Shell-Bash

在编写 Shell-Bash 脚本时,我们常常会遇到各式各样的错误提示信息。但是默认情况下,vscode 对这些错误提示信息的显示并不够友好,让人很难快速地定位错误所在。

下面就分享一些方法,让 vscode 在遇到 Shell-Bash 错误时能够更漂亮地显示提示信息。

安装 ShellCheck

ShellCheck 是一款 Bash 脚本语法检查工具,它可以帮助我们检查脚本中的语法错误、变量未定义等问题,并且在 vscode 中安装 ShellCheck 后,它可以让我们更方便地定位错误。

安装 ShellCheck 可以通过以下命令:

sudo apt-get install shellcheck
安装 Shell-Check 插件

安装完 ShellCheck 后,打开 vscode,我们还需要安装 Shell-Check 插件。它可以在我们编辑 Shell 脚本时自动调用 ShellCheck,检查我们所写的代码是否合法。

在 vscode 的插件市场中,搜索并安装 "Shell-Check" 插件。

配置 Shell-Check 插件

安装完 Shell-Check 插件后,我们还需要针对当前项目(如果是全局设置请打开用户设置)进行 Shell-Check 插件的配置。

在 vscode 的 "设置" 中搜索 "shellcheck",可以看到插件相关的配置项。根据自己的项目需求,可以进行如下配置:

"shellcheck.enable": true,          // 启用 Shell-Check 插件
"shellcheck.run": "onType",         // 默认对所输字符进行实时检查,也可选择 onSave(保存时检查)或 off(手动检查)
"shellcheck.followShebang": true,   // 遵守首行解释器规则,检查脚本中使用的命令是否匹配。如:#!/bin/bash
检查 Shell 脚本

当我们按照以上步骤进行配置后,重新打开 Shell 脚本文件时,就能发现错误提示信息的展示发生了变化。当我们写下错误的代码时,即使还没有保存脚本,错误信息也能自动提示出来。

例如下方的脚本中:

#!/bin/bash

ech "Hello World!"

在未保存或未执行代码时,Shell-Check 插件就会将错误代码标记出来,如下图所示:

Shell-Check 插件提示错误

在我们保存脚本后,还能进一步定位错误所在,如下图所示:

Shell-Check 插件提示错误详细信息

现在你已经可以在 vscode 中更方便、更漂亮地处理 Shell-Bash 错误提示信息了。