【亲测免费】 ShellCheck for Visual Studio Code 下载及安装教程

1. 项目介绍

ShellCheck for Visual Studio Code 是一个将 ShellCheck 集成到 Visual Studio Code 中的扩展。ShellCheck 是一个用于 Shell 脚本的静态分析工具，能够帮助开发者发现和修复 Shell 脚本中的常见错误。通过这个扩展，开发者可以在 VS Code 中直接使用 ShellCheck 进行代码检查，提高 Shell 脚本的编写质量。

2. 项目下载位置

ShellCheck for Visual Studio Code 的项目源代码托管在 GitHub 上。你可以通过以下命令克隆项目到本地：

git clone https://github.com/vscode-shellcheck/vscode-shellcheck.git

3. 项目安装环境配置

3.1 系统要求

• 操作系统: Linux, macOS, Windows
• Visual Studio Code: 版本 1.40.0 或更高
• ShellCheck: 项目中已包含预编译的 ShellCheck 二进制文件，支持 Linux (x86_64, arm, arm64), macOS (x86_64, arm64), Windows (x86_64, arm)。

3.2 环境配置示例

以下是配置示例的图片：

4. 项目安装方式

4.1 通过 VS Code 扩展市场安装

1. 打开 Visual Studio Code。
2. 点击左侧活动栏中的扩展图标（或按 Ctrl+Shift+X）。
3. 在搜索框中输入 ShellCheck。
4. 找到 ShellCheck 扩展并点击 Install 按钮进行安装。

4.2 通过源代码安装

1. 克隆项目到本地：

   git clone https://github.com/vscode-shellcheck/vscode-shellcheck.git
   

2. 进入项目目录：

   cd vscode-shellcheck
   

3. 安装项目依赖：

   npm install
   

4. 构建项目：

   npm run compile
   

5. 在 VS Code 中打开项目目录：

   code .
   

6. 按 F5 启动扩展开发主机，进行调试和测试。

5. 项目处理脚本

ShellCheck for Visual Studio Code 提供了一些处理脚本，帮助开发者进行代码检查和错误修复。以下是一些常用的处理脚本示例：

5.1 收集当前文档的诊断信息

在 VS Code 中，你可以通过命令面板运行 ShellCheck: Collect Diagnostics For Current Document 命令，收集当前文档的诊断信息。

5.2 自动修复错误

你可以配置 VS Code 在保存文件时自动修复可自动修复的错误。在 settings.json 中添加以下配置：

{
  "editor.codeActionsOnSave": {
    "source.fixAll.shellcheck": "explicit"
  }
}

5.3 使用 Docker 版本的 ShellCheck

如果你希望使用 Docker 版本的 ShellCheck，可以创建一个简单的 "shim" 脚本，并配置扩展使用该脚本。以下是一个示例脚本：

#!/bin/bash
exec docker run --rm --interactive --volume "$PWD:/mnt:ro" koalaman/shellcheck:latest "$@"

将该脚本保存为 shellcheck.sh，并赋予执行权限：

chmod +x shellcheck.sh

然后在 settings.json 中配置扩展使用该脚本：

{
  "shellcheck.executablePath": "${workspaceFolder}/shellcheck.sh",
  "shellcheck.useWorkspaceRootAsCwd": true
}

通过以上步骤，你就可以成功下载、安装并配置 ShellCheck for Visual Studio Code 扩展，开始使用 ShellCheck 进行 Shell 脚本的静态分析了。