What is this?

LuaExtended is a syntax definition and snippet package for Sublime Text 3.

Features

As of right now, LuaExtended contains the following improvements over the default Lua package:

• Indentation of repeat until loops fixed

• Indentation of table definitions fixed

• Improved syntax definition structure for easier future work on more fixes

• error calls have red-highlighted strings

• Completions include the full standard library, including parameter names with tab stops

• Completions also include Lua keywords

• New snippets:

  • New loop snippets (while and repeat)

  • Improved indentation of for snippets, synced variable name tab stops

  • ++ (expands the current line into the form of line = line + 1, ignoring inline comments and whitespace)

  • += and -=

  • dfun, an LDoc-style documented function snippet

  • if, elseif and else

  • if~, if=, and their elseif counterparts, expanding to if x ~= y then ... and similar

  • Most snippets also handle selection, meaning you can e.g. apply while on a block of code which will then become the body of the while loop

• Function calls (including object method invocations foo:bar() and syntactic sugar like foo { bar }) are highlighted properly

• Anonymous function definitions are highlighted properly (arguments are formatted)

• Restructured indent settings

  • do end blocks are indented properly

• All features are grouped under the source.luae scope, so that they don't interfere with the default Lua package

Installation

You can now use Package Control to install LuaExtended. Simply type “install” in the Command Palette (Ctrl + Shift + P) to find the Package Control: Install Package command. Wait for the repository lists to load

and search for 'LuaExtended'. Alternatively, you can clone this repository into your Data/User folder (either in the install directory, in %appdata%/Sublime Text 3 on Windoze, or wherever else other environments put it).

LuaExtended and Linters

If you are using a SublimeLinter3-based linter such as SublimeLinter-lua, you will need to modify your settings to get LuaExtended linting to work.

Navigate to Preferences > Package Settings

Find SublimeLinter in the list and open its “Settings - User”

The settings file is of the JSON format, so look for the line that says "syntax_map": {

You will need to add a binding that tells SublimeLinter to lint LuaExtended just like Lua. This is done by adding a line that says "luaextended": "lua",. Don't worry about the alphabetical order of the entries, SublimeLinter will sort them on next reload.

And there you go! Try opening a *.luae, *.ext.lua or *.extended.lua file and see whether linting works. If it for some reason doesn't work, read the tutorial again and check that you've followed it to the point. Try restarting Sublime before opening an issue!