Implement textDocument/rangeFormatting (sublimelsp#166)

* Implement textDocument/rangeFormatting

There might be race bugs when using this with multiple selections.

* Only format selection when a single selection is present

Author: rwols

Commands/Default.sublime-commands

@@ -36,6 +36,11 @@
     	"command": "lsp_format_document",
     	"args": {}
     },
+    {
+        "caption": "LSP: Format Selection",
+        "command": "lsp_format_document_range",
+        "args": {}
+    },
     {
         "caption": "LSP: Restart Servers",
         "command": "lsp_restart_client",
@@ -51,4 +56,4 @@
         "command": "lsp_show_diagnostics_panel",
         "args": {}
     }
-]
+]

Menus/Context.sublime-menu

@@ -20,5 +20,9 @@
         "command": "lsp_format_document",
         "caption": "Format Document"
     },
+    {
+        "command": "lsp_format_document_range",
+        "caption": "Format Selection"
+    },
     { "caption": "-", "id": "lsp_end"}
-]
+]

docs/index.md

@@ -259,6 +259,7 @@ Any fields in a client configuration can be overridden by adding an LSP settings
     * Recommendation: Override `f12` (built-in goto definition),
     * LSP falls back to ST3's built-in goto definition command in case LSP fails.
 * Format Document: UNBOUND
+* Format Selection: UNBOUND
 * Document Symbols: UNBOUND
 
 **Workspace actions**

main.py

@@ -178,6 +178,10 @@ def executeCommand(cls, params: dict):
     def formatting(cls, params: dict):
         return Request("textDocument/formatting", params)
 
+    @classmethod
+    def rangeFormatting(cls, params: dict):
+        return Request("textDocument/rangeFormatting", params)
+
     @classmethod
     def documentSymbols(cls, params: dict):
         return Request("textDocument/documentSymbol", params)
@@ -1398,7 +1402,7 @@ def run(self, edit):
                     "uri": filename_to_uri(self.view.file_name())
                 },
                 "options": {
-                    "tabSize": 4,
+                    "tabSize": 4,  # TODO: Fetch these from the project settings / global settings
                     "insertSpaces": True
                 }
             }
@@ -1411,6 +1415,36 @@ def handle_response(self, response, pos):
                               {'changes': response})
 
 
+class LspFormatDocumentRangeCommand(sublime_plugin.TextCommand):
+    def is_enabled(self):
+        if is_supported_view(self.view):
+            client = client_for_view(self.view)
+            if client and client.has_capability('documentRangeFormattingProvider'):
+                if len(self.view.sel()) == 1:
+                    region = self.view.sel()[0]
+                    if region.begin() != region.end():
+                        return True
+        return False
+
+    def run(self, _):
+        client = client_for_view(self.view)
+        if client:
+            region = self.view.sel()[0]
+            params = {
+                "textDocument": {
+                    "uri": filename_to_uri(self.view.file_name())
+                },
+                "range": Range.from_region(self.view, region).to_lsp(),
+                "options": {
+                    "tabSize": 4,  # TODO: Fetch these from the project settings / global settings
+                    "insertSpaces": True
+                }
+            }
+            client.send_request(Request.rangeFormatting(params),
+                                lambda response: self.view.run_command('lsp_apply_document_edit',
+                                                                       {'changes': response}))
+
+
 class LspSymbolDefinitionCommand(sublime_plugin.TextCommand):
     def is_enabled(self, event=None):
         # TODO: check what kind of scope we're in.