ShellCheck for Visual Studio Code

Integrates ShellCheck into VS Code, a linter for Shell scripts.

Quick start

Disclaimer

vscode-shellcheck (this "extension"), requires shellcheck (the awesome static analysis tool for shell scripts) to work.

Since v0.10.0, precompiled shellcheck binaries are bundled for these platforms:

• Linux (x86_64)
• macOS (x86_64)
• Windows: precompiled 32bit binary will be used on both 32bit and 64bit Windows, please note that this requires you have WoW64 enabled, althouth it's not a problem for Desktop users.

Requirements

1. Run Install Extension command from Command Palette.
2. Search and choose shellcheck.

Options

There are various options that can be configured by making changes to your user or workspace preferences.

Default options are:

{
    "shellcheck.enable": true,
    "shellcheck.enableQuickFix": true,
    "shellcheck.run": "onType",
    "shellcheck.executablePath": "",  // Priority: user defined > bundled shellcheck binary > "shellcheck"
    "shellcheck.exclude": [],
    "shellcheck.customArgs": [],
    "shellcheck.ignorePatterns": {
        "**/*.zsh": true,
        "**/*.zshrc": true,
        "**/zshrc": true,
        "**/*.zprofile": true,
        "**/zprofile": true,
        "**/*.zlogin": true,
        "**/zlogin": true,
        "**/*.zlogout": true,
        "**/zlogout": true,
        "**/*.zshenv": true,
        "**/zshenv": true,
        "**/*.zsh-theme": true
    },
    "shellcheck.ignoreFileSchemes": ["git", "gitfs"],
}

shellcheck.ignorePatterns

The shellcheck.ignorePatterns works exactly the same as search.exclude, read more about glob patterns here

For example:

{
    "shellcheck.ignorePatterns": {
        "**/*.zsh": true,
        "**/*.zsh*": true,
        "**/.git/*.sh": true,
        "**/folder/**/*.sh": true
    }
}

Experimental Quick Fix

In order to enable the "auto fix" feature, shellcheck v0.7.0 or better is required.

Since this feature is still in experimental, additionally, shellcheck.enableQuickFix should be true:

{
    "shellcheck.enableQuickFix": true
}

Lint onType or onSave

By default the linter will lint as you type. Alternatively, set shellcheck.run to onSave if you want to lint only when the file is saved (works best if auto-save is on).

{
    "shellcheck.run": "onType" // also: "onSave"
}

Excluding Checks

By default all shellcheck checks are performed and reported on as necessary. To globally ignore certain checks in all files, add the "SC identifiers" to shellcheck.exclude. For example, to exclude SC1017:

{
    "shellcheck.exclude": ["1017"],
}

Using Docker version of shellcheck

In order to get it work, you need a "shim" script, and then, just remember, do not try to construct command line arguments for shellcheck yourself.

Here is a simple "shim" script to get start with (See discussion: #24):

#!/bin/bash

exec docker run --rm -i -v "$PWD:/mnt:ro" koalaman/shellcheck:v0.7.0 "[email protected]"

Acknowledgements

This extension is based on hoovercj's Haskell Linter.

Contributors

• @felipecrs
• @sylveon
• @ralish

LICENSE

This extension is licensed under the MIT license.

Bundled shellcheck binaries are licensed under GPLv3.