LaTeX linter plugin for SublimeLinter 3, using chktex.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
messages
.gitignore
.travis.yml
LICENSE
README.md
linter.py
messages.json

README.md

SublimeLinter-chktex

Build Status

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 must be installed in order to use this plugin.

Please use Package Control to install the linter plugin.

Before installing this plugin, 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. Make sure you don't have any spaces in the path to MikTeX

  2. Install cygwin with the make and gcc compiler packages

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

  4. In the cygwin bash, run

    cd c:
    cd cygwin64/home/USER
    cd chktex-1.7.2
    configure
    make
    make install
    
  5. 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)

Please make sure that the path to chktex is available to SublimeLinter. The docs cover troubleshooting PATH configuration.

Settings

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.

Additional settings for SublimeLinter-chktex:

  • nowarn: A comma-separated list of warnings to ignore.
  • erroron: A comma-separated list of warnings to output as errors.