Add format on paste

LSP.sublime-settings

@@ -7,6 +7,9 @@
 
   // --- Document Formatting ------------------------------------------------------------
 
+  // Run the server's documentRangeFormattingProvider (if supported) on the pasted text.
+  "format_on_paste": false,
+
   // Run the server's formatProvider (if supported) on a file before saving.
   // This option is also supported in syntax-specific settings and/or in the
   // "settings" section of project files.

plugin/core/types.py

@@ -205,6 +205,7 @@ class Settings:
     diagnostics_panel_include_severity_level = cast(int, None)
     disabled_capabilities = cast(List[str], None)
     document_highlight_style = cast(str, None)
+    format_on_paste = cast(bool, None)
     hover_highlight_style = cast(str, None)
     inhibit_snippet_completions = cast(bool, None)
     inhibit_word_completions = cast(bool, None)
@@ -250,6 +251,7 @@ def r(name: str, default: Union[bool, int, str, list, dict]) -> None:
         r("diagnostics_panel_include_severity_level", 4)
         r("disabled_capabilities", [])
         r("document_highlight_style", "underline")
+        r("format_on_paste", False)
         r("hover_highlight_style", "")
         r("initially_folded", [])
         r("link_highlight_style", "underline")

plugin/documents.py

@@ -170,6 +170,7 @@ def on_change() -> None:
         self._registration = SettingsRegistration(view.settings(), on_change=on_change)
         self._completions_task = None  # type: Optional[QueryCompletionsTask]
         self._stored_selection = []  # type: List[sublime.Region]
+        self._did_paste = False
         self._setup()
 
     def __del__(self) -> None:
@@ -528,7 +529,9 @@ def on_text_command(self, command_name: str, args: Optional[dict]) -> Optional[T
         return None
 
     def on_post_text_command(self, command_name: str, args: Optional[Dict[str, Any]]) -> None:
-        if command_name in ("next_field", "prev_field") and args is None:
+        if command_name == 'paste' and userprefs().format_on_paste:
+            self._did_paste = True
+        elif command_name in ("next_field", "prev_field") and args is None:
             sublime.set_timeout_async(lambda: self.do_signature_help_async(manual=True))
         if not self.view.is_popup_visible():
             return
@@ -936,6 +939,9 @@ def _on_view_updated_async(self) -> None:
             self._when_selection_remains_stable_async(
                 self._do_highlights_async, first_region, after_ms=self.highlights_debounce_time)
         self.do_signature_help_async(manual=False)
+        if self._did_paste:
+            self._did_paste = False
+            self._format_on_paste_async()
 
     def _update_stored_selection_async(self) -> Tuple[Optional[sublime.Region], bool]:
         """
@@ -959,6 +965,32 @@ def _update_stored_selection_async(self) -> Tuple[Optional[sublime.Region], bool
         self._stored_selection = selection
         return changed_first_region, True
 
+    def _format_on_paste_async(self) -> None:
+        self.purge_changes_async()
+        clipboard_text = sublime.get_clipboard()
+        sel = self.view.sel()
+        split_clipboard_text = clipboard_text.split('\n')
+        multi_cursor_paste = len(split_clipboard_text) == len(sel) and len(sel) > 1
+        original_selection = list(sel)
+        regions_to_format = []  # type: List[sublime.Region]
+        pasted_text = clipboard_text
+        # add regions to selection, in order for lsp_format_document_range to format those regions
+        for index, region in enumerate(sel):
+            if multi_cursor_paste:
+                pasted_text = split_clipboard_text[index]
+            pasted_region = self.view.find(pasted_text, region.end(), sublime.REVERSE | sublime.LITERAL)
+            if pasted_region:
+                # Including whitespace may help servers format a range better
+                # More info at https://github.com/sublimelsp/LSP/pull/2311#issuecomment-1688593038
+                a = self.view.find_by_class(pasted_region.a, False,
+                                            sublime.CLASS_WORD_END | sublime.CLASS_PUNCTUATION_END)
+                formatting_region = sublime.Region(a, pasted_region.b)
+                regions_to_format.append(formatting_region)
+        sel.add_all(regions_to_format)
+        self.view.run_command('lsp_format_document_range')
+        sel.clear()
+        sel.add_all(original_selection)
+
     def _clear_session_views_async(self) -> None:
         session_views = self._session_views
 

sublime-package.json

@@ -444,6 +444,11 @@
               "default": false,
               "markdownDescription": "Show errors and warnings count in the status bar."
             },
+            "format_on_paste": {
+              "type": "boolean",
+              "default": false,
+              "markdownDescription": "Run the server's documentRangeFormattingProvider (if supported) on the pasted text."
+            },
             "lsp_format_on_save": {
               "$ref": "sublime://settings/LSP#/definitions/lsp_format_on_save"
             },