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 65K
  • Win 32K
  • OS X 19K
  • Linux 13K
Apr 23 Apr 22 Apr 21 Apr 20 Apr 19 Apr 18 Apr 17 Apr 16 Apr 15 Apr 14 Apr 13 Apr 12 Apr 11 Apr 10 Apr 9 Apr 8 Apr 7 Apr 6 Apr 5 Apr 4 Apr 3 Apr 2 Apr 1 Mar 31 Mar 30 Mar 29 Mar 28 Mar 27 Mar 26 Mar 25 Mar 24 Mar 23 Mar 22 Mar 21 Mar 20 Mar 19 Mar 18 Mar 17 Mar 16 Mar 15 Mar 14 Mar 13 Mar 12 Mar 11 Mar 10 Mar 9
Windows 17 13 14 35 27 32 26 25 15 20 36 43 35 24 30 11 22 25 20 30 32 24 13 16 19 23 23 35 25 20 22 33 30 30 31 35 25 22 38 65 34 33 32 19 18 35
OS X 9 4 14 13 15 20 11 16 4 6 14 18 10 19 19 9 11 17 11 11 14 9 10 16 13 18 18 16 23 10 8 14 15 16 23 24 7 15 27 29 21 33 28 22 16 22
Linux 6 8 6 11 7 7 18 7 6 4 15 9 6 5 12 6 8 9 9 9 5 7 4 9 7 13 8 14 13 7 5 8 15 9 18 19 7 7 10 18 21 8 15 12 5 13

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].