Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for multi-range formatting #2299

Merged
merged 3 commits into from
Aug 6, 2023
Merged

Add support for multi-range formatting #2299

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
17fa510
Add support for multi-range formatting
jwortmann Jul 14, 2023
d1e6983
Merge branch 'main' into ranges-formatting
jwortmann Aug 4, 2023
59f3cd6
Bug detected
jwortmann Aug 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion plugin/core/sessions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -334,7 +334,8 @@ def get_initialize_params(variables: Dict[str, str], workspace_folders: List[Wor
"dynamicRegistration": True # exceptional
},
"rangeFormatting": {
"dynamicRegistration": True
"dynamicRegistration": True,
"rangesSupport": True
},
"declaration": {
"dynamicRegistration": True,
Expand Down
8 changes: 8 additions & 0 deletions plugin/core/views.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -592,6 +592,14 @@ def text_document_range_formatting(view: sublime.View, region: sublime.Region) -
}, view, progress=True)


def text_document_ranges_formatting(view: sublime.View) -> Request:
return Request("textDocument/rangesFormatting", {
"textDocument": text_document_identifier(view),
"options": formatting_options(view.settings()),
"ranges": [region_to_range(view, region) for region in view.sel() if not region.empty()]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Spec doesn't seem to specify that range can't be empty. I would think that it could potentially be useful to place multiple cursors in multiple places and expect the code around those places to be formatted.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would understand the specs in the way that servers must respond with TextEdits which are only allowed to modify the document within the given range(s).

The document range formatting request is sent from the client to the server to format a given range in a document.

So if the range is empty, there is nothing useful a server could do, other than sending an empty/null response. Do you know of any server which behaves different?

In fact, LSP already prevents empty selections for range formatting at the moment:

LSP/plugin/formatting.py

Lines 117 to 119 in e608f87

def is_enabled(self, event: Optional[dict] = None, point: Optional[int] = None) -> bool:
if super().is_enabled(event, point):
return has_single_nonempty_selection(self.view)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Based on me just trying LSP-json and using Format Selection, it seems like you are right. I haven't tried with empty selection of course since that is disabled, but I've tried with very small selection to see if server expands formatting beyond the selection but it seemed to only format within the selection.

Maybe worth trying some more servers before agreeing here...

}, view, progress=True)


def selection_range_params(view: sublime.View) -> SelectionRangeParams:
return {
"textDocument": text_document_identifier(view),
Expand Down
39 changes: 30 additions & 9 deletions plugin/formatting.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
from .core.views import has_single_nonempty_selection
from .core.views import text_document_formatting
from .core.views import text_document_range_formatting
from .core.views import text_document_ranges_formatting
from .core.views import will_save_wait_until
from .save_command import LspSaveCommand, SaveTask
import sublime
Expand Down Expand Up @@ -115,16 +116,27 @@ class LspFormatDocumentRangeCommand(LspTextCommand):
capability = 'documentRangeFormattingProvider'

def is_enabled(self, event: Optional[dict] = None, point: Optional[int] = None) -> bool:
if super().is_enabled(event, point):
return has_single_nonempty_selection(self.view)
if not super().is_enabled(event, point):
return False
if has_single_nonempty_selection(self.view):
return True
if self.view.has_non_empty_selection_region() and \
bool(self.best_session('documentRangeFormattingProvider.rangesSupport')):
return True
return False

def run(self, edit: sublime.Edit, event: Optional[dict] = None) -> None:
session = self.best_session(self.capability)
selection = first_selection_region(self.view)
if session and selection is not None:
req = text_document_range_formatting(self.view, selection)
session.send_request(req, lambda response: apply_text_edits_to_view(response, self.view))
if has_single_nonempty_selection(self.view):
session = self.best_session(self.capability)
selection = first_selection_region(self.view)
if session and selection is not None:
req = text_document_range_formatting(self.view, selection)
session.send_request(req, lambda response: apply_text_edits_to_view(response, self.view))
elif self.view.has_non_empty_selection_region():
session = self.best_session('documentRangeFormattingProvider.rangesSupport')
if session:
req = text_document_ranges_formatting(self.view)
session.send_request(req, lambda response: apply_text_edits_to_view(response, self.view))


class LspFormatCommand(LspTextCommand):
Expand All @@ -139,11 +151,20 @@ def is_visible(self, event: Optional[dict] = None, point: Optional[int] = None)
return self.is_enabled(event, point)

def description(self, **kwargs) -> str:
return "Format Selection" if self._range_formatting_available() else "Format File"
if self._range_formatting_available():
if has_single_nonempty_selection(self.view):
return "Format Selection"
return "Format Selections"
return "Format File"

def run(self, edit: sublime.Edit, event: Optional[dict] = None) -> None:
command = 'lsp_format_document_range' if self._range_formatting_available() else 'lsp_format_document'
self.view.run_command(command)

def _range_formatting_available(self) -> bool:
return has_single_nonempty_selection(self.view) and bool(self.best_session('documentRangeFormattingProvider'))
if has_single_nonempty_selection(self.view) and bool(self.best_session('documentRangeFormattingProvider')):
return True
if self.view.has_non_empty_selection_region() and \
bool(self.best_session('documentRangeFormattingProvider.rangesSupport')):
return True
return False