JSHint plugin for Gedit
Clone or download
Meseira Merge pull request #5 from lwindolf/patch-1
Hint on easy install with gedit-plugininstaller
Latest commit 1503bb7 Nov 19, 2017

README.md

JSHint plugin for Gedit

This software is a plugin for the text editor Gedit. It allows to check JavaScript source code with the static code analysis tool JSHint. To get more information about JSHint and to try it online, visit the official website.

  • Author: Xavier Gendre

Requirements

This plugin is for Gedit 3 and is not compatible with Gedit 2.

The JavaScript runtime environment Node.js is needed to run the JSHint script. In a Debian-like operating system, simply install the package nodejs:

apt-get install nodejs

Installation

For easy automatic installation you can install this plugin using the Gedit Plugin Installer or you can do it manually:

  1. Download this repository by clicking the Download ZIP button at the top of the GitHub page or clone it with the following command:

    git clone https://github.com/Meseira/gedit-jshint.git

  2. Copy the file jshint.plugin and the folder jshint to ~/.local/share/gedit/plugins/ (you will need to create this folder if it does not already exist).

  3. Restart Gedit.

  4. Activate the plugin in the Gedit Preferences, go to the Plugins tab and check the box next to JSHint.

Usage

When a JavaScript source code file is active, you can check it with Tools > Check with JSHint or with the accelerator Ctrl+J. The results are automatically displayed in the bottom panel.

Notes

For now, the plugin only checks JavaScript source code with the JSHint default parameters. Allowing to modify the options is in the TODO list and will be available soon, hopefully. However, inline configuration can be used to set JSHint options.

License

The JSHint plugin for Gedit is a free software and is distributed under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. A copy of this license can be found in the file LICENSE included with the source code of this plugin.

The included JSHint script (found in the subdirectory jshint/js/) has its own license, namely the MIT Expat License, which can be found in the file jshint/js/LICENSE included with the source code of this plugin.
Website: https://github.com/jshint/jshint/blob/master/dist/jshint.js

Compatibility

The JSHint plugin has been tested with Debian Jessie and Gedit 3.14. It should work without any trouble with any version of Gedit 3. Feel free to report any other working environment.

Issues

If you encounter any problem with this software, do not hesitate to report it in a GitHub issue.