Merge branch 'release/0.0.9'

Author: John Towers

README.md

@@ -14,9 +14,11 @@ Supports most useful CLI commands including:
 * Push\Pull source
 * Create Apex classes
 * Run tests for an org or specific class
+* Run SOQL query
+
+This plugin also supports:
 * Code completion
 * Diagnostics
-Uses syntax highlighting from MavensMate
 
 Language services (e.g., code completion and diagnostics) are provided by the [Apex Language Server](https://developer.salesforce.com/docs/atlas.en-us.sfdx_ide2.meta/sfdx_ide2/sfdx_ide2_build_app_apex_language_server_protocol.htm)
 
@@ -25,12 +27,26 @@ Language services (e.g., code completion and diagnostics) are provided by the [A
 * `debug`: true or false to enable/disable printing debug statements to the sublime console
 * `java_home`: location of your java binary if it is not in your PATH
 
+## Getting Started
+The plugin adds a new menu item (DXMate), context menu items, and command pallette items. Many of these are only enabled if you have an sfdx project currently opened.
+
+If you don't have an sfdx proejct created, you can use DXMate > Project > Create Project to create one. If you do have one created, use Project > Add Folder to Project to add it to a project.
+
+After that you can work with the rest of the commands (e.g., authorizing a dev hub and then creating a scratch org).
+
 ## To Do
 * Additional settings (e.g., disable language services)
 * Better handling of window opening (currently only starts language server if dx project is loaded when sublime is opened)
-* Additional language services
+* Add goto symbol definition from latest language server update
+* Add support for additional sfdx cli commands
+
+## Compatibility
+This should be compatible with windows, osx and linux with ST3.
+
+It's been tested on windows 10 and ubuntu 16.
 
 
 ## Credits
-Most utility functions are based on or copied from [MavensMate](https://github.com/joeferraro/MavensMate-SublimeText)
-The LSP client code is cloned from the [Sublime LSP package](https://github.com/tomv564/LSP)
+* Most utility functions are based on or copied from [MavensMate](https://github.com/joeferraro/MavensMate-SublimeText). The syntax files for Apex are also from the MavensMate project.
+
+* The LSP client code is adapted from the [Sublime LSP package](https://github.com/tomv564/LSP)

dxmate.py

@@ -13,7 +13,7 @@
 from .lib.threads import PanelThreadProgress
 from .lib.languageServer import *
 from .lib.event_hub import EventHub
-from .lib.util import *
+from .lib.util import util
 from .lib.diagnostic import *
 import ntpath
 
@@ -120,11 +120,11 @@ def description(self):
 def plugin_loaded():
     global lsClient
     global printer
-    if dxProjectFolder() != '':
+    if util.dxProjectFolder() != '':
         lsClient = start_client()
         if lsClient is None:
-            debug('Unable start langauge server')
-
+            util.debug('Unable start langauge server')
+        EventHub.subscribe('on_load_async', set_syntax)
     active_window_id = sublime.active_window().id()
     printer = PanelPrinter.get(active_window_id)
     printer.write("sfdx plugin loaded", erase=True)
@@ -135,6 +135,14 @@ def plugin_unloaded():
         lsClient.kill()
 
 
+def set_syntax(view):
+    if util.is_apex_file(view):
+        util.debug('setting syntax for file')
+        if "linux" in sys.platform or "darwin" in sys.platform:
+            view.set_syntax_file(os.path.join("Packages",util.plugin_name(),"sublime","lang","Apex.sublime-syntax"))
+        else:
+            view.set_syntax_file(os.path.join("Packages/"+util.plugin_name()+"/sublime/lang/Apex.sublime-syntax"))
+
 class ExitHandler(sublime_plugin.EventListener):
 
     def on_window_commad(self, window, command_name, args):
@@ -179,13 +187,13 @@ def on_text_command(self, window, command_name, *args):
         else:
             EventHub.publish('on_window_command', window, command_name, *args)
     def on_modified_async(self, view):
-        active_file_extension = file_extension(view)
+        active_file_extension = util.file_extension(view)
         if active_file_extension != '.cls' and active_file_extension != '.trigger':
             return None
         EventHub.publish("on_modified_async", view)
 
     def on_query_completions(self, view, prefix, locations):
-        active_file_extension = file_extension(view)
+        active_file_extension = util.file_extension(view)
         if active_file_extension != '.cls' and active_file_extension != '.trigger':
             return None
 
@@ -205,7 +213,7 @@ def on_query_completions(self, view, prefix, locations):
             purge_did_change(view.buffer_id())
             client.send_request(
                 Request.complete(
-                    get_document_position(view, locations[0])),
+                    util.get_document_position(view, locations[0])),
                 self.handle_response)
         self.refreshing = False
         return self.completions, (sublime.INHIBIT_WORD_COMPLETIONS
@@ -247,8 +255,8 @@ def run_auto_complete(self):
 class DxmateRunFileTestsCommand(sublime_plugin.WindowCommand):
 
     def run(self):
-        self.dx_folder = dxProjectFolder()
-        self.active_file = active_file()
+        self.dx_folder = util.dxProjectFolder()
+        self.active_file = util.active_file()
         self.active_file = ntpath.split(self.active_file)[
             1].replace('.cls', '')
         self.class_name = 'ApexClassName'
@@ -263,13 +271,13 @@ def run(self):
         PanelThreadProgress(t, 'Running Tests')
 
     def is_enabled(self):
-        self.dx_folder = dxProjectFolder()
+        self.dx_folder = util.dxProjectFolder()
         if(self.dx_folder == ''):
             return False
-        self.active_file = active_file()
+        self.active_file = util.active_file()
         if not self.active_file.endswith('.cls'):
             return False
-        if not file_is_test(self.window.active_view()):
+        if not util.file_is_test(self.window.active_view()):
             return False
         return True
 
@@ -300,7 +308,7 @@ class DxmateRunOrgTestsCommand(sublime_plugin.TextCommand):
 
     def run(self, edit):
 
-        self.dx_folder = dxProjectFolder()
+        self.dx_folder = util.dxProjectFolder()
         sublime.active_window().show_input_panel(
             'Org (leave blank for default)', '', self.run_tests, None, None)
 
@@ -317,7 +325,7 @@ def run_tests(self, input):
         PanelThreadProgress(t, 'Running Org Tests')
 
     def is_enabled(self):
-        self.dx_folder = dxProjectFolder()
+        self.dx_folder = util.dxProjectFolder()
         if self.dx_folder == '':
             return False
         return True
@@ -350,7 +358,7 @@ def run_command(self):
 class DxmatePushSourceCommand(sublime_plugin.TextCommand):
 
     def run(self, edit):
-        self.dx_folder = dxProjectFolder()
+        self.dx_folder = util.dxProjectFolder()
         printer.show()
         printer.write('\nPushing Source')
         t = threading.Thread(target=self.run_command)
@@ -362,7 +370,7 @@ def run(self, edit):
         PanelThreadProgress(t, 'Source Pushed')
 
     def is_enabled(self):
-        self.dx_folder = dxProjectFolder()
+        self.dx_folder = util.dxProjectFolder()
         if self.dx_folder == '':
             return False
         return True
@@ -394,7 +402,7 @@ def run_command(self):
 class DxmatePullSourceCommand(sublime_plugin.TextCommand):
 
     def run(self, edit):
-        self.dx_folder = dxProjectFolder()
+        self.dx_folder = util.dxProjectFolder()
         printer.show()
         t = threading.Thread(target=self.run_command)
         t.start()
@@ -406,7 +414,7 @@ def run(self, edit):
         PanelThreadProgress(t, 'Source Pulled')
 
     def is_enabled(self):
-        self.dx_folder = dxProjectFolder()
+        self.dx_folder = util.dxProjectFolder()
         if self.dx_folder == '':
             return False
         return True
@@ -438,7 +446,7 @@ def run_command(self):
 class DxmateOpenScratchOrgCommand(sublime_plugin.TextCommand):
 
     def run(self, edit):
-        self.dx_folder = dxProjectFolder()
+        self.dx_folder = util.dxProjectFolder()
         printer.show()
         t = threading.Thread(target=self.run_command)
         t.start()
@@ -450,7 +458,7 @@ def run(self, edit):
         PanelThreadProgress(t, 'Org Opened')
 
     def is_enabled(self):
-        self.dx_folder = dxProjectFolder()
+        self.dx_folder = util.dxProjectFolder()
         if self.dx_folder == '':
             return False
         return True
@@ -478,7 +486,7 @@ def run_command(self):
 class DxmateCreateScratchOrgCommand(sublime_plugin.TextCommand):
 
     def run(self, edit):
-        self.dx_folder = dxProjectFolder()
+        self.dx_folder = util.dxProjectFolder()
         self.def_file = os.path.join(
             self.dx_folder, 'config', 'project-scratch-def.json')
         sublime.active_window().show_input_panel(
@@ -497,7 +505,7 @@ def create_org(self, input):
         PanelThreadProgress(t, 'Scratch Org Created')
 
     def is_enabled(self):
-        self.dx_folder = dxProjectFolder()
+        self.dx_folder = util.dxProjectFolder()
         if self.dx_folder == '':
             return False
         return True
@@ -537,13 +545,13 @@ def run(self, edit):
         PanelThreadProgress(t, 'Auth Page Opened')
 
     def is_enabled(self):
-        dx_folder = dxProjectFolder()
+        dx_folder = util.dxProjectFolder()
         if dx_folder == '':
             return False
         return True
 
     def run_command(self):
-        dx_folder = dxProjectFolder()
+        dx_folder = util.dxProjectFolder()
         args = ['sfdx', 'force:auth:web:login', '-d', '-s', '-a', 'DevHub']
         startupinfo = None
         if os.name == 'nt':
@@ -570,7 +578,7 @@ def run(self):
             'Query', '', self.run_query, None, None)
 
     def is_enabled(self, paths=[]):
-        dx_folder = dxProjectFolder()
+        dx_folder = util.dxProjectFolder()
         if(dx_folder == ''):
             return False
         return True
@@ -588,7 +596,7 @@ def run_query(self, input):
         PanelThreadProgress(t, 'Query run')
 
     def run_command(self):
-        dx_folder = dxProjectFolder()
+        dx_folder = util.dxProjectFolder()
         args = ['sfdx', 'force:data:soql:query',
                 '-q', self.query]
         startupinfo = None
@@ -608,9 +616,9 @@ def run_command(self):
             #try:
             #    parsed = json.loads(content)
             #    content = json.dumps(parsed,  sort_keys=True,indent=1, separators=(',', ':'))
-            #    debug(content)
+            #    util.debug(content)
             #except Exception as e:
-            #    debug('could not format query results\n', e)
+            #    util.debug('could not format query results\n', e)
             file = sublime.active_window().new_file()
             file.set_scratch(True)
             file.set_name('SOQL')
@@ -639,7 +647,7 @@ def run(self, paths=[]):
             'Class Name', self.class_name, self.create_class, None, None)
 
     def is_enabled(self, paths=[]):
-        dx_folder = dxProjectFolder()
+        dx_folder = util.dxProjectFolder()
         if(dx_folder == ''):
             return False
         if len(paths) != 1 or (len(paths) > 0 and os.path.isfile(paths[0])):
@@ -659,7 +667,7 @@ def create_class(self, input):
         PanelThreadProgress(t, 'Apex Class Created')
 
     def run_command(self):
-        dx_folder = dxProjectFolder()
+        dx_folder = util.dxProjectFolder()
         args = ['sfdx', 'force:apex:class:create',
                 '-n', self.class_name, '-d', self.class_dir]
         startupinfo = None
@@ -696,13 +704,13 @@ def run(self, edit):
         PanelThreadProgress(t, 'Project Upgraded')
 
     def is_enabled(self):
-        dx_folder = dxProjectFolder()
+        dx_folder = util.dxProjectFolder()
         if dx_folder == '':
             return False
         return True
 
     def run_command(self):
-        dx_folder = dxProjectFolder()
+        dx_folder = util.dxProjectFolder()
         args = ['sfdx', 'force:project:upgrade', '-f']
         startupinfo = None
         if os.name == 'nt':
@@ -782,3 +790,5 @@ def run_command(self):
         else:
             printer.write('\nError creating project:')
             printer.write('\n' + str(out, 'UTF-8'))
+
+

lib/__init__.py

@@ -0,0 +1,6 @@
+from .util import util
+from .event_hub import EventHub
+_all_ = [
+'util',
+'EventHub'
+]