SublimeLinter-luacheck

This linter plugin for SublimeLinter provides an interface to luacheck. It will be used with files that have the “Lua” 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 using this plugin, you must ensure that luacheck is installed on your system. To install luacheck, follow the instructions at the luacheck home page.

Linter configuration

In order for luacheck 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 you have installed and configured luacheck, you can proceed to install the SublimeLinter-luacheck 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 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.
When the plugin list appears, type SublimeLinter-luacheck. Among the entries you should see SublimeLinter-luacheck. 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-luacheck provides its own settings. Those marked as “Inline Setting” or “Inline Override” may also be used inline.

Setting	Description	Inline Setting	Inline Override
ignore	Do not report warnings related to these variables	✓	✓
only	Only report warnings related to these variables	✓	✓
globals	Defined globals	✓	✓
limit	The maximum number of warnings	✓

These settings are passed through to luacheck as command line options. Please see the luacheck documentation for more information.

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.
Please use descriptive variable names, no abbrevations unless they are very well known.

Thank you for helping out!