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

Lua​Complete

A Sublime Text 3 plugin for the lua-complete engine

Details

Installs

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

Readme

Source
raw.​githubusercontent.​com

LuaComplete for Sublime Text 3 (BETA)

LuaComplete is an ST3 plugin that does auto-completing of Lua code. It uses the lua-complete engine for auto-completion and makes your Lua development a lot easier! Image of LuaComplete in Action

Installation

  1. Install lua-complete

  2. Install the plugin. Currently, you can only install it manually:

    cd /Users/[user]/Library/Application Support/Sublime Text 3/Packages/
    git clone https://github.com/FourierTransformer/LuaComplete-Sublime LuaComplete
    

    I'm working on a few more things before getting it in Package Control.

  3. That's about it! LuaComplete will start up the server and send code automatically via the client. There are a few settings that can be tweaked, as referenced below.

Settings

The default settings should work out of the box, but they can be modified via the Preferences menu or from the Command Palette (Ctrl+Shift+P and type LuaComplete). Make any changes in the User settings. You will likely need to restart Sublime Text after changing settings. Here are the default settings:

{
    // Path to the directory containing lua-complete executables
    // if installed everywhere, just "lua-complete" should be fine
    "path": "lua-complete",

    // Port to use for the lua-complete client and server
    "port": 24548,

    // enable/disable toggle. it is enabled by default 
    // set it to false to turn off LuaComplete
    // and restart Sublime Text for it to take effect
    // "enabled": true,
    // NOTE: it can also be enabled/disabled via the command palette 
    // but will only stick until the next Sublime Text reboot

    // additional include location
    // by default lua-complete will search lua's regular 
    // installed module paths (packages.path)
    // 
    // The LuaComplete plugin will send the currently
    // open folder in the sublime text view for analysis
    // 
    // Additional include locations can be specified in a
    // semi-colon delimited list below (be sure to comment out the line below)
    // "additional_includes": "/my/random/file/path;/another/path"
}

Features and Shortcomings

  • It will only auto-complete things in tables - which includes most lua modules!
  • It can only determine function parameters for Lua functions (it currently doesn't know if a parameter is optional or not).
  • It should work with project-level files (by searching through the folder open in sublime text or folder the file resides in)
  • In the future, it should include function parameters for the built-in lua functions. However, it is not possible to determine function parameters for other C functions - without hard-coding them in.

Comparison between Lua and C functions

The LuaComplete plugin will show the difference between when it can fill in function parameters (for Lua functions) and when it can't (for C functions). Take a look at the example below:

Lua Function

The Lua function parameters get auto-completed and in the Sublime Text auto-complete hover - the function is described as function ():

Image of LuaComplete completing lua function parameters

C Function

The C functions parameters don't get auto-completed and the function is described as function: Image of LuaComplete completing lua function parameters

Troubleshooting

If you see the error message “The lua-complete client failed to return” in the bottom right, try running the “LuaComplete: Clear Auto-complete Cache (Restart Server)” from the command palette. This will restart the server, and hopefully the client will be able to reconnect.

Questions and Contributing

Feel free to open a Github issue with any questions/issues/features that you have! Also, check out CONTRIBUTING.md if you want to help!

Licenses

LuaComplete is released under the MIT License