Skip to content
This repository has been archived by the owner on Jan 8, 2024. It is now read-only.

Latest commit

 

History

History
48 lines (32 loc) · 2.71 KB

README.md

File metadata and controls

48 lines (32 loc) · 2.71 KB

ShellCheck plugin for Gedit

GitHub release GitHub tag GitHub license GitHub issues GitHub issues-closed contributions welcome GitHub contributors Github All Releases

This software is a plugin for the text editor Gedit. It allows to check shell scripts using the ShellCheck linter.

Screenshot

Contributors

  • This plugin is derived from the JSHint Gedit plugin by Xavier Gendre
  • Live checking and matching improvements by Jürgen Key

Requirements

Requires Gedit 3.14+ and ShellCheck being installed. On Debian-based distros install it using

apt install shellcheck

Installation

You might want to install the plugin using the Gedit Plugin Installer or using these manual steps

git clone https://github.com/lwindolf/gedit-shellcheck.git
mkdir -p ~/.local/share/gedit/plugins/
cp -r gedit-shellcheck/shellcheck.plugin gedit-shellcheck/shellcheck/ ~/.local/share/gedit/plugins/

Ensure to restart Gedit and activate the plugin in the preferences.

Usage

When a shell source code file is active, you can check it

  • editing and moving the cursor to the next line
  • or by selecting menu option Tools > Check with ShellCheck

The results are automatically displayed in the bottom panel.