added ability to disable if wanted

Author: FourierTransformer

LuaComplete.py

@@ -22,6 +22,7 @@ def is_server_running(quick=False):
         return False
 
 def start_server():
+    global state
     # print("starting server")
     if not is_server_running():
         # clean up any old instances that may be running...
@@ -73,11 +74,10 @@ def create_completion(completion):
 
 class LuaComplete(sublime_plugin.EventListener):    
     def on_query_completions(self, view, prefix, locations):
-        global state
-
         position = locations[0]
         scopes = view.scope_name(position).split()
-        if ('source.lua' not in scopes):
+
+        if ('source.lua' not in scopes or state["enabled"] == False):
             return None
 
         # load the server if it's not running.
@@ -115,7 +115,7 @@ def on_query_completions(self, view, prefix, locations):
         file_contents = view.substr(sublime.Region(0, view.size())).encode('utf8')
 
         # send it to the client
-        print(command)
+        # print(command)
         client = Popen(command, shell=True, stdin=PIPE, stdout=PIPE, stderr=STDOUT)
         # print(file_contents)
         # print(position)
@@ -156,6 +156,16 @@ def run(self):
         stop_server()
         start_server()
 
+class DisableCommand(sublime_plugin.ApplicationCommand):
+    def run(self):
+        global state
+        state["enabled"] = False
+
+class EnableCommand(sublime_plugin.ApplicationCommand):
+    def run(self):
+        global state
+        state["enabled"] = True
+
 def plugin_loaded():
     global state
     state["settings"] = sublime.load_settings("LuaComplete.sublime-settings")
@@ -168,9 +178,15 @@ def plugin_loaded():
     if port is None:
         port = 24548
 
+    # figure out if it's enabled
+    enabled = state["settings"].get("enabled")
+    if enabled is None:
+        enabled = True
+
     # setup the command.
     state["server_command"] = "{path} server -p {port}".format(path=path, port=port)
     state["client_command"] = "{path} client -p {port}".format(path=path, port=port)
+    state["enabled"] = enabled
 
     # get any additional include locations
     state["additional_includes"] = state["settings"].get("additional_includes")

LuaComplete.sublime-commands

@@ -3,6 +3,14 @@
         "caption": "LuaComplete: Clear Auto-complete Cache (Restart Server)",
         "command": "clear_cache"
     },
+    {
+        "caption": "LuaComplete: Disable",
+        "command": "disable"
+    },
+    {
+        "caption": "LuaComplete: Enable",
+        "command": "enable"
+    },
     {
         "caption": "Preferences: LuaComplete Settings – Default",
         "command": "open_file", "args":

LuaComplete.sublime-settings

@@ -6,6 +6,12 @@
   // Port to use for the lua-complete client and server
   "port": 24548,
 
+  // enable/disable toggle. it is enabled by default 
+  // you would set it to false to turn off LuaComplete
+  // "enabled": false,
+  // NOTE: it can also be toggled via the command palette 
+  // but will only apply until Sublime Text reboots
+
   // additional include location
   // by default lua-complete will search lua's regular 
   // installed module paths (packages.path)

README.md

@@ -16,7 +16,7 @@ LuaComplete is an ST3 plugin that does auto-completing of Lua code. It uses the
 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. Here are the default 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
@@ -26,6 +26,12 @@ The default settings should work out of the box, but they can be modified via th
     // Port to use for the lua-complete client and server
     "port": 24548,
 
+    // enable/disable toggle. it is enabled by default
+    // you would set it to false to turn off LuaComplete
+    // "enabled": false,
+    // NOTE: it can also be toggled via the command palette 
+    // but will only apply until Sublime Text reboots
+
     // additional include location
     // by default lua-complete will search lua's regular 
     // installed module paths (packages.path)