Merge pull request #209 from zhengbli/fixFormatOnKey

Move the trigger of ``format_on_key`` command to ``on_modified``

Author: zhengbli

Default.sublime-keymap

@@ -135,57 +135,6 @@
             { "key": "selector", "operator": "equal", "operand": "source.ts" },
             { "key": "is_popup_visible"}
         ]
-    },    // In case when auto match is enabled, only format if not within {}
-    {
-        "keys": [ "}" ],
-        "command": "typescript_format_on_key",
-        "args": { "key": "}" },
-        "context": [
-            { "key": "selector", "operator": "equal", "operand": "source.ts" },
-            { "key": "setting.typescript_auto_format", "operator": "equal", "operand": true },
-            { "key": "setting.auto_match_enabled", "operator": "equal", "operand": true },
-            { "key": "num_selections", "operator": "equal", "operand": 1},
-            { "key": "selection_empty", "operator": "equal", "operand": true },
-
-            { "key": "preceding_text", "operator": "not_regex_contains", "operand": "\\{$" },
-            { "key": "following_text", "operator": "not_regex_contains", "operand": "^\\}" }
-        ]
-    },
-    // In case when auto match is disabled, format the block regardless
-    {
-        "keys": [ "}" ],
-        "command": "typescript_format_on_key",
-        "args": { "key": "}" },
-        "context": [
-            { "key": "num_selections", "operator": "equal", "operand": 1},
-            { "key": "setting.typescript_auto_format", "operator": "equal", "operand": true },
-            { "key": "selection_empty", "operator": "equal", "operand": true, "match_all": true },
-            { "key": "selector", "operator": "equal", "operand": "source.ts" },
-            { "key": "setting.auto_match_enabled", "operator": "equal", "operand": false }
-        ]
-    },
-    {
-        "keys": [ ";" ],
-        "command": "typescript_format_on_key",
-        "args": { "key": ";" },
-        "context": [
-            { "key": "selection_empty", "operator": "equal", "operand": true, "match_all": true },
-            { "key": "setting.typescript_auto_format", "operator": "equal", "operand": true },
-            { "key": "selector", "operator": "equal", "operand": "source.ts" }
-        ]
-    },
-    {
-        "keys": [ "enter" ],
-        "command": "typescript_format_on_key",
-        "args": { "key": "\n" },
-        "context": [
-            { "key": "setting.typescript_auto_indent", "operator": "equal", "operand": true },
-            { "key": "auto_complete_visible", "operator": "equal", "operand": false },
-            { "key": "selector", "operator": "not_equal", "operand": "meta.scope.between-tag-pair" },
-            { "key": "selection_empty", "operator": "equal", "operand": true, "match_all": true },
-            { "key": "num_selections", "operator": "equal", "operand": 1},
-            { "key": "selector", "operator": "equal", "operand": "source.ts" }
-        ]
     },
     {
         "keys": [ "enter" ],

typescript/commands/format.py

@@ -14,11 +14,6 @@ def run(self, text, key="", insert_key=True):
         if 0 == len(key):
             return
         check_update_view(self.view)
-        loc = self.view.sel()[0].begin()
-
-        if insert_key:
-            active_view().run_command('hide_auto_complete')
-            insert_text(self.view, text, loc, key)
 
         format_response = cli.service.format_on_key(self.view.file_name(), get_location_from_view(self.view), key)
         if format_response["success"]:

typescript/libs/__init__.py

@@ -5,7 +5,6 @@
 from .popup_manager import get_popup_manager
 from .logger import log
 from . import logger
-
 __all__ = [
     'cli',
     'EditorClient',

typescript/libs/editor_client.py

@@ -34,6 +34,9 @@ def __init__(self):
         self.tab_size = 4
         self.indent_size = 4
         self.translate_tab_to_spaces = False
+        self.ts_auto_format_enabled = True
+        self.ts_auto_indent_enabled = True
+        self.auto_match_enabled = True
 
     def initialize(self):
         """
@@ -55,7 +58,14 @@ def initialize(self):
         self.service = ServiceProxy(self.node_client)
 
         # load formatting settings and set callbacks for setting changes
-        for setting_name in ['tab_size', 'indent_size', 'translate_tabs_to_spaces']:
+        for setting_name in [
+            'tab_size',
+            'indent_size',
+            'translate_tabs_to_spaces',
+            'typescript_auto_format',
+            'typescript_auto_indent',
+            'auto_match_enabled'
+        ]:
             settings.add_on_change(setting_name, self.load_format_settings)
         self.load_format_settings()
 
@@ -66,6 +76,9 @@ def load_format_settings(self):
         self.tab_size = settings.get('tab_size', 4)
         self.indent_size = settings.get('indent_size', 4)
         self.translate_tab_to_spaces = settings.get('translate_tabs_to_spaces', False)
+        self.ts_auto_format_enabled = settings.get("typescript_auto_format")
+        self.ts_auto_indent_enabled = settings.get("typescript_auto_indent")
+        self.auto_match_enabled = settings.get("auto_match_enabled")
         self.set_features()
 
     def set_features(self):

typescript/libs/global_vars.py

@@ -4,23 +4,34 @@
 import sublime
 from os.path import dirname
 
+# determine if the host is sublime text 2
+IS_ST2 = int(sublime.version()) < 3000
 
 # Get the directory path to this file;
-# Note: MODULE_DIR, PLUGIN_DIR and PLUGIN_NAME only works correctly when:
-# 1. Using sublime 3
-# 2. Using sublime 2, and the plugin folder is not a symbol link
-# On sublime 2 with the plugin folder being a symbol link, the PLUGIN_FOLDER will points
-# to the linked real path instead, and the PLUGIN_NAME will be wrong too.
-MODULE_DIR = dirname(dirname(os.path.abspath(__file__)))
-PLUGIN_DIR = dirname(MODULE_DIR)
+# Note: there are several ways this plugin can be installed
+# 1. from the package control -> the absolute path of __file__ is real and contains plugin name
+# 2. git clone directly to the sublime packages folder -> the absolute path of __file__ is real and contains plugin name
+# 3. git clone to somewhere else, and link to the sublime packages folder -> the absolute path is real in Sublime 3,
+# but is somewhere else in Sublime 2;and therefore in Sublime 2 there is no direct way to obtain the plugin name
+if not IS_ST2:
+    PLUGIN_DIR = dirname(dirname(dirname(os.path.abspath(__file__))))
+else:
+    _sublime_packages_dir = sublime.packages_path()
+    _cur_file_abspath = os.path.abspath(__file__)
+    if _sublime_packages_dir not in _cur_file_abspath:
+        # The plugin is installed as a link
+        for p in os.listdir(_sublime_packages_dir):
+            link_path = _sublime_packages_dir + os.sep + p
+            if os.path.realpath(link_path) in _cur_file_abspath:
+                PLUGIN_DIR = link_path
+                break
+    else:
+        PLUGIN_DIR = dirname(dirname(dirname(os.path.abspath(__file__))))
 PLUGIN_NAME = os.path.basename(PLUGIN_DIR)
 
 # only Sublime Text 3 build after 3072 support tooltip
 TOOLTIP_SUPPORT = int(sublime.version()) >= 3072
 
-# determine if the host is sublime text 2
-IS_ST2 = int(sublime.version()) < 3000
-
 # detect if quick info is available for symbol
 SUBLIME_WORD_MASK = 515
 

typescript/listeners/format.py

@@ -1,5 +1,7 @@
 from .event_hub import EventHub
-
+from ..libs.view_helpers import *
+from ..libs.logger import log
+from ..libs import cli
 
 class FormatEventListener:
     def on_post_text_command_with_info(self, view, command_name, args, info):
@@ -11,5 +13,35 @@ def on_post_text_command_with_info(self, view, command_name, args, info):
              "typescript_paste_and_format"]:
             print("handled changes for " + command_name)
 
+    def on_modified_with_info(self, view, info):
+        log.debug("Format on key")
+
+        if (
+            is_typescript(view) and
+            cli.ts_auto_format_enabled and
+            info.prev_sel and
+            len(info.prev_sel) == 1 and
+            info.prev_sel[0].empty()
+        ):
+            last_command, args, repeat_times = view.command_history(0)
+            log.debug("last_command:{0}, args:{1}".format(last_command, args))
+            if last_command == "insert":
+                pos = info.prev_sel[0].begin()
+                if ";" in args["characters"]:
+                    view.run_command("typescript_format_on_key", {"key": ";"})
+                if "}" in args["characters"]:
+                    if cli.auto_match_enabled:
+                        prev_char = view.substr(pos - 1)
+                        post_char = view.substr(pos + 1)
+                        log.debug("prev_char: {0}, post_char: {1}".format(prev_char, post_char))
+                        if prev_char != "{" and post_char != "}":
+                            view.run_command("typescript_format_on_key", {"key": "}"})
+                    else:
+                        view.run_command("typescript_format_on_key", {"key": "}"})
+                if "\n" in args["characters"]:
+                    if cli.ts_auto_indent_enabled and view.score_selector(pos, "meta.scope.between-tag-pair") > 0:
+                        view.run_command("typescript_format_on_key", {"key": "\n"})
+
 listener = FormatEventListener()
-EventHub.subscribe("on_post_text_command_with_info", listener.on_post_text_command_with_info)
+EventHub.subscribe("on_post_text_command_with_info", listener.on_post_text_command_with_info)
+EventHub.subscribe("on_modified_with_info", listener.on_modified_with_info)