ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Summit​Linter

by corvisa ST3

SublimeLinter plugin for the CorvisaCloud Summit platform

Details

Installs

  • Total 71K
  • Win 35K
  • OS X 21K
  • Linux 14K
Oct 22 Oct 21 Oct 20 Oct 19 Oct 18 Oct 17 Oct 16 Oct 15 Oct 14 Oct 13 Oct 12 Oct 11 Oct 10 Oct 9 Oct 8 Oct 7 Oct 6 Oct 5 Oct 4 Oct 3 Oct 2 Oct 1 Sep 30 Sep 29 Sep 28 Sep 27 Sep 26 Sep 25 Sep 24 Sep 23 Sep 22 Sep 21 Sep 20 Sep 19 Sep 18 Sep 17 Sep 16 Sep 15 Sep 14 Sep 13 Sep 12 Sep 11 Sep 10 Sep 9 Sep 8 Sep 7
Windows 0 12 12 18 20 24 20 18 11 11 16 27 22 21 18 10 10 19 29 25 23 23 10 10 17 26 18 20 16 12 11 16 23 23 21 27 9 16 20 17 20 24 24 14 13 23
OS X 0 0 3 8 15 9 12 9 4 10 12 18 6 11 9 6 13 17 10 11 12 11 3 6 13 12 16 8 9 6 5 15 10 11 7 11 6 7 11 18 17 12 10 2 8 16
Linux 0 7 3 7 10 7 12 9 9 4 5 12 8 12 9 7 3 5 10 13 8 4 3 5 9 7 7 11 11 3 2 7 10 8 7 8 6 2 5 12 6 9 10 5 6 8

Readme

Source
raw.​githubusercontent.​com

SummitLinter

This linter plugin for SublimeLinter provides an interface to Corvisa LLC's SummitEditor through luacheck. It will be used with files that have the “Lua (Summit)” syntax.

Installation

SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions here. SummitEditor must also be installed. If it is not installed, follow the instructions.

Linter installation

Before using this plugin, you must ensure that luacheck is installed on your system. To install luacheck, follow the instructions.

Note: luacheck requires lua to be installed.

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 SummitLinter 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 SummitLinter. Among the entries you should see SummitLinter. 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, SummitLinter provides its own settings adapted from the luacheck settings. Those marked as “Default Setting" have their own setting in SublimeLinter's user settings for summitlinter. Those not marked as “Default Setting” go in the args list in SublimeLinter's user settings for summitlinter.

Setting Description Default Setting
-g, --no-global Do not check for accessing global variables.
-r, --no-redefined Do not check for redefined variables.
-u, --no-unused Do not check for unused variables.
-a, --no-unused-args Do not check for unused arguments and loop variables.
-v, --no-unused-values Do not check for unused values.
globals [<global>] Defined globals.
-c, --compat Adjust globals for Lua 5.1/5.2 compatibility.
-e, --ignore-env Do not be _ENV-aware.
ignore [<var>] Do not report warnings related to these variables
only [<var>] Only report warnings related to these variables
limit <limit> Exit with 0 if there are <limit> or less warnings.
-q, --quiet Suppress output for files without warnings. -qq: Only print total number of warnings and errors. -qqq: Suppress output completely.

Settings marked as “Default Setting” may also be used inline as per SublimeLinter's documentation. Since, by default, channel and require are pre-defined as globals, using the globalssetting inline requires you to include channel and require again in addition to any other settings. For example: -- [SublimeLinter summitlinter-globals:channel,require,foo] will maintain default behavior while adding foo as a global. This follows for any default settings saved in SublimeLinter's user settings as well. For example, if "ignore": "foo" is in your user settings, using ignore to ignore bar inline (while continuing to ignore foo) would require the following: -- [SublimeLinter summitlinter-ignore:foo,bar].