node-shellcheck

ShellCheck

Node wrapper of ShellCheck, a GPLv3 tool that gives warnings and suggestions for bash/sh shell scripts.

This package downloads koalaman's shellcheck from the official servers and makes the binary available at node_modules/.bin/shellcheck. There is also a NodeJS module available so you can execute directly from JavaScript.

const shellcheck = require("node-shellcheck");
shellcheck("tests/example.bash");

Installation

yarn add --dev shellcheck

Usage

Edit package.json to call shellcheck from your npm/yarn scripts:

{
  "scripts": {
    "lint": "shellcheck '**/*.sh'"
  }
}

Related

• hadolint: Lint Dockerfiles and the inline bash code in them

License

• http://gunar.mit-license.org