https://github.com/lwindolf/gedit-shellcheck

Gedit3 plugin for linting shell scripts using ShellCheck
https://github.com/lwindolf/gedit-shellcheck

bash gedit linter-plugin shell-scripts

Last synced: 3 months ago
JSON representation

Gedit3 plugin for linting shell scripts using ShellCheck

• Host: GitHub
• URL: https://github.com/lwindolf/gedit-shellcheck
• Owner: lwindolf
• License: gpl-3.0
• Archived: true
• Created: 2017-11-07T22:17:13.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2022-07-16T22:42:20.000Z (over 2 years ago)
• Last Synced: 2024-06-08T23:32:42.315Z (5 months ago)
• Topics: bash, gedit, linter-plugin, shell-scripts
• Language: Python
• Size: 43 KB
• Stars: 3
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
ShellCheck plugin for Gedit

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

[![GitHub release](https://img.shields.io/github/release/lwindolf/gedit-shellcheck/all.svg?maxAge=1)](https://GitHub.com/lwindolf/gedit-shellcheck/releases/)

[![GitHub tag](https://img.shields.io/github/tag/lwindolf/gedit-shellcheck.svg)](https://GitHub.com/lwindolf/gedit-shellcheck/tags/)

[![GitHub license](https://img.shields.io/github/license/lwindolf/gedit-shellcheck.svg)](https://github.com/lwindolf/gedit-shellcheck/blob/master/LICENSE)

[![GitHub issues](https://img.shields.io/github/issues/lwindolf/gedit-shellcheck.svg)](https://GitHub.com/lwindolf/gedit-shellcheck/issues/)

[![GitHub issues-closed](https://img.shields.io/github/issues-closed/lwindolf/gedit-shellcheck.svg)](https://GitHub.com/lwindolf/gedit-shellcheck/issues?q=is%3Aissue+is%3Aclosed)

[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/lwindolf/gedit-shellcheck/issues)

[![GitHub contributors](https://img.shields.io/github/contributors/lwindolf/gedit-shellcheck.svg)](https://GitHub.com/lwindolf/gedit-shellcheck/graphs/contributors/)

[![Github All Releases](https://img.shields.io/github/downloads/lwindolf/gedit-shellcheck/total.svg)](https://github.com/lwindolf/gedit-shellcheck)

This software is a plugin for the text editor [Gedit](https://wiki.gnome.org/Apps/Gedit). It allows to check shell scripts using the [ShellCheck](https://www.shellcheck.net/) linter.

![Screenshot](https://lzone.de/images/gedit-shellcheck.png)

## Contributors

- This plugin is derived from the JSHint Gedit plugin by [Xavier Gendre](https://github.com/Meseira/gedit-jshint)

- Live checking and matching improvements by [Jürgen Key](https://github.com/elbosso)

## 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](https://github.com/lwindolf/gedit-plugininstaller) 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.