SublimeLinter-chktex

This linter plugin for SublimeLinter provides an interface to ChkTeX. It will be used with files that have use LaTeX (or LaTeXing) syntax.

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 installing this plugin, you must ensure that chktex is installed on your system. ChkTeX is available on CTAN and comes with e.g. TeX Live starting with TeX Live 2011, and available for many platforms.

If you are using a TeX distribution which does not include ChkTeX (for example MiKTeX) follow the instructions below to compile ChkTeX manually:

1. Install cygwin with make and gcc compiler

2. Download chktex and save in home directory of cygwin (default is C:\cygwin\home\USER)

3. In the cygwin bash, run configure and make

4. The resulting chktex.exe along with cygwin1.dll should now be saved in a directory which is registered in the PATH environment variable (for example %MiKTeX Install%\miktex\bin\ is appropriate)

Linter configuration

In order for chktex 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 chktex is installed and configured, you can proceed to install the SublimeLinter-chktex 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:

1. Within Sublime Text, bring up the Command Palette and type install. Among the commands you should see Package 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.

2. When the plugin list appears, type chktex. Among the entries you should see SublimeLinter-chktex. 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.

In addition to the standard SublimeLinter settings, SublimeLinter-chktex provides its own settings, which may also be used inline as overrides. For a full list of warnings see the ChkTeX manual.

By default, SublimeLinter-chktex ignores Warning 22 (Comment displayed) and Warning 30 (Multiple spaces detected in output). It also sets Warning 16 (Mathmode is still on at end of LaTeX file) as an error.

Setting	Description	Default
nowarn	A comma-separated list of warnings to ignore.	[22,30]
erroron	A comma-separated list of warnings to output as errors.	[16]

Contributing

If you would like to contribute enhancements or fixes, please do the following:

1. Fork the plugin repository.
2. Hack on a separate topic branch created from the latest master.
3. Commit and push the topic branch.
4. Make a pull request.
5. 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!