SublimeLinter 3 plugin for Lua, using luac -p.
Python
Latest commit 8f4bd98 Jul 26, 2016 @groteworld groteworld committed on GitHub Merge pull request #4 from aubergine10/patch-1
readme.md - Fixed link to homebrew

README.md

SublimeLinter-lua

Build Status

This linter plugin for SublimeLinter provides an interface to luac -p. 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 lua (which includes luac) is installed on your system. To install lua, do one of the following:

  1. Install a binary from the binaries downloads page.

  2. On Mac OS X, use homebrew to install by typing the following in a terminal:

    brew install lua
    

    Note that more recent versions of lua may be available via brew, type brew search lua to check.

  3. On Windows, you can install with Lua for Windows.

Linter configuration

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

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!