https://github.com/SublimeLinter/SublimeLinter-shellcheck

This linter plugin for SublimeLinter provides an interface to shellcheck.
https://github.com/SublimeLinter/SublimeLinter-shellcheck

Last synced: 3 days ago
JSON representation

This linter plugin for SublimeLinter provides an interface to shellcheck.

• Host: GitHub
• URL: https://github.com/SublimeLinter/SublimeLinter-shellcheck
• Owner: SublimeLinter
• License: mit
• Created: 2013-12-19T16:05:29.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2024-09-01T13:27:08.000Z (8 months ago)
• Last Synced: 2025-04-07T08:18:40.507Z (8 days ago)
• Language: Python
• Size: 27.3 KB
• Stars: 215
• Watchers: 11
• Forks: 21
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - SublimeLinter/SublimeLinter-shellcheck - This linter plugin for SublimeLinter provides an interface to shellcheck. (Python)

README

        
SublimeLinter-shellcheck

=========================

[![Build Status](https://travis-ci.org/SublimeLinter/SublimeLinter-shellcheck.svg?branch=master)](https://travis-ci.org/SublimeLinter/SublimeLinter-shellcheck)

This linter plugin for [SublimeLinter](https://github.com/SublimeLinter/SublimeLinter) provides an interface to [shellcheck](http://www.shellcheck.net/about.html).

It will be used with files that have the "Shell-Unix-Generic" syntax (aka Shell Script (Bash)).

## Installation

SublimeLinter must be installed in order to use this plugin. 

Please use [Package Control](https://packagecontrol.io) to install the linter plugin.

Before using this plugin, ensure that `shellcheck` is installed on your system.

To install `shellcheck`, follow the instructions on [the shellcheck GitHub repository](https://github.com/koalaman/shellcheck).

`shellcheck` can be installed with ``apt-get`` on Debian sid, ``brew`` on Mac OS X, or compiled from its Haskell sources (manually, or through `cabal`). 

On Windows either install natively or use the Linux Subsystem. See [Microsoft's guide](https://docs.microsoft.com/en-us/windows/wsl/install-win10), then run `wsl sudo apt update` and `wsl sudo apt install shellcheck` to install Shellcheck (if you installed Ubuntu).

On native Linux systems, Please make sure that the path to `shellcheck` is available to SublimeLinter.

The docs cover [troubleshooting PATH configuration](http://sublimelinter.com/en/latest/troubleshooting.html#finding-a-linter-executable).

## Settings

- SublimeLinter settings: http://sublimelinter.com/en/latest/settings.html

- Linter settings: http://sublimelinter.com/en/latest/linter_settings.html

Additional SublimeLinter-shellcheck settings:

|Setting|Description|

|:------|:----------|

|exclude|A comma-delimited list of codes to exclude.|

E.g. you can use a single string (eg: ``"SC2034,SC2086"``), or an array of strings (eg: ``["SC2034", "SC2086"]``).