SublimeLinter-jsxhint
This linter plugin for SublimeLinter provides an interface to jsxhint. It will be used with files that have the “JSX” syntax.
JSX is a JavaScript XML syntax transform intended for use with React.js.
Installation
SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions here.
Linter installation
Before using this plugin, you must ensure that jsxhint
is installed on your system. To install jsxhint
, do the following:
-
Install
jsxhint
by typing the following in a terminal:npm install -g jsxhint
-
If you are using
nvm
andzsh
, ensure that the line to loadnvm
is in.zshenv
and not.zshrc
.
Linter configuration
In order for jsxhint
to be executed by SublimeLinter, you must ensure that its path is available to SublimeLinter. Before going any further, please read and follow the steps in “Finding a linter executable” through “Validating your PATH” in the documentation.
Once jsxhint
is installed and configured, you can proceed to install the SublimeLinter-jsxhint plugin if it is not yet installed.
Plugin installation
Please use Package Control to install the linter plugin. This will ensure that the plugin will be updated when new versions are available. If you want to install from source so you can modify the source code, you probably know what you are doing so we won’t cover that here.
To install via Package Control, do the following:
-
Within Sublime Text, bring up the Command Palette and type
install
. Among the commands you should seePackage Control: Install Package
. If that command is not highlighted, use the keyboard or mouse to select it. There will be a pause of a few seconds while Package Control fetches the list of available plugins. -
When the plugin list appears, type
jsxhint
. Among the entries you should seeSublimeLinter-jsxhint
. If that entry is not highlighted, use the keyboard or mouse to select it.
Settings
For general information on how SublimeLinter works with settings, please see Settings. For information on generic linter settings, please see Linter Settings.
You can configure jshint
options in the way you would from the command line, with .jshintrc
files. For more information, see the jshint docs.
Note: The linter plugin does this by searching for a .jshintrc
file itself and setting the --config
option if it finds one, so you cannot use that option in the linter’s "args"
setting.
Contributing
If you would like to contribute enhancements or fixes, please do the following:
- Fork the plugin repository.
- Hack on a separate topic branch created from the latest
master
. - Commit and push the topic branch.
- Make a pull request.
- Be patient. ;-)
Please note that modications should follow these coding guidelines:
- Indent is 4 spaces.
- Code should pass flake8 and pep257 linters.
- Vertical whitespace helps readability, don’t be afraid to use it.
Thank you for helping out!