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.

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

Combine file and range formatting entries in context menu #2123

Merged
merged 1 commit into from
Nov 26, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 1 addition & 6 deletions Context.sublime-menu
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,7 @@
"caption": "Source Action…"
},
{
"command": "lsp_format_document",
"caption": "Format File"
},
{
"command": "lsp_format_document_range",
"caption": "Format Selection"
"command": "lsp_format"
},
{
"command": "lsp_expand_selection",
Expand Down
1 change: 1 addition & 0 deletions boot.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
from .plugin.documents import TextChangeListener
from .plugin.edit import LspApplyDocumentEditCommand
from .plugin.execute_command import LspExecuteCommand
from .plugin.formatting import LspFormatCommand
from .plugin.formatting import LspFormatDocumentCommand
from .plugin.formatting import LspFormatDocumentRangeCommand
from .plugin.goto import LspSymbolDeclarationCommand
Expand Down
5 changes: 5 additions & 0 deletions plugin/core/views.py
Original file line number Diff line number Diff line change
Expand Up @@ -431,6 +431,11 @@ def first_selection_region(view: sublime.View) -> Optional[sublime.Region]:
return None


def has_single_nonempty_selection(view: sublime.View) -> bool:
selections = view.sel()
return len(selections) == 1 and not selections[0].empty()


def entire_content_region(view: sublime.View) -> sublime.Region:
return sublime.Region(0, view.size())

Expand Down
28 changes: 24 additions & 4 deletions plugin/formatting.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
from .core.typing import Any, Callable, List, Optional, Iterator, Union
from .core.views import entire_content_region
from .core.views import first_selection_region
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 will_save_wait_until
Expand Down Expand Up @@ -114,10 +115,7 @@ class LspFormatDocumentRangeCommand(LspTextCommand):

def is_enabled(self, event: Optional[dict] = None, point: Optional[int] = None) -> bool:
if super().is_enabled(event, point):
if len(self.view.sel()) == 1:
region = self.view.sel()[0]
if region.begin() != region.end():
return True
return has_single_nonempty_selection(self.view)
return False

def run(self, edit: sublime.Edit, event: Optional[dict] = None) -> None:
Expand All @@ -126,3 +124,25 @@ def run(self, edit: sublime.Edit, event: Optional[dict] = None) -> None:
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))


class LspFormatCommand(LspTextCommand):

def is_enabled(self, event: Optional[dict] = None, point: Optional[int] = None) -> bool:
if not super().is_enabled():
return False
return bool(self.best_session('documentFormattingProvider')) or \
bool(self.best_session('documentRangeFormattingProvider'))

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

def description(self, **kwargs) -> str:
return "Format Selection" if self._range_formatting_available() else "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'))