Skip to content
shellcheck linter for vscode
Branch: master
Clone or download
Latest commit c00cb41 Dec 20, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode Fix vscode launch & tasks May 31, 2018
src Fix lint issues Sep 27, 2018
test Add more tests for extension May 9, 2018
.editorconfig Add CI May 9, 2018
.gitignore Add CI May 9, 2018
.travis.yml Fix wrong highlight position with tabs May 9, 2018
.vscodeignore Add more tests for extension May 9, 2018
LICENSE Upate LICENSE May 30, 2018
README.md Fix lint issues Sep 27, 2018
package-lock.json Update lock file Dec 20, 2018
package.json Fix lint issues Sep 27, 2018
tsconfig.json Fix lint issues Sep 27, 2018
tslint.json Update vscode requirements Oct 13, 2017

README.md

vscode-shellcheck

https://travis-ci.com/timonwong/vscode-shellcheck Current Version Install Count Greenkeeper badge

Requirements

  1. Ensure shellcheck is installed (v0.4.7 or better is recommended to use).
  2. Run Install Extension command from Command Palette.
  3. 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.run": "onType",
    "shellcheck.executablePath": "shellcheck",
    "shellcheck.exclude": [],
    "shellcheck.customArgs": [],
    "shellcheck.ignorePatterns": {},
    "shellcheck.useWSL": false
}

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.5.0 "$@"

Acknowledgements

This extension is based on hoovercj's Haskell Linter.

You can’t perform that action at this time.