Skip to content
A ShellCheck-powered backend for Flymake
Emacs Lisp
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
LICENSE
README.md
flymake-shellcheck.el

README.md

flymake-shellcheck

Melpa Status Melpa Status

An Emacs (26+) Flymake handler for bash/sh scripts, using ShellCheck. Installing Flymake is not necessary as it is included in Emacs itself.

Installation

First, make sure ShellCheck is installed by following the installation guide. After that, you can install flymake-shellcheck by using the package-install command (make sure MELPA is included in your package sources):

M-x package-install [RET] flymake-shellcheck [RET]

Alternatively, you can just add flymake-shellcheck.el to your load-path.

Usage

To enable the Flymake backend whenever a bash or sh script is visited, add the following to your init.el file:

(add-hook 'sh-mode-hook 'flymake-shellcheck-load)

If you're using use-package, try this instead:

(use-package flymake-shellcheck
  :commands flymake-shellcheck-load
  :init
  (add-hook 'sh-mode-hook 'flymake-shellcheck-load))

After opening a shell/sh file, remember to enable Flymake:

M-x flymake-mode [RET]

License

Copyright © 2019 Federico Tedin.

Distributed under the GNU General Public License, version 3.

You can’t perform that action at this time.