feat: support formatting

Author: betaboon

pylsp_ruff/plugin.py

@@ -4,7 +4,7 @@
 import sys
 from pathlib import PurePath
 from subprocess import PIPE, Popen
-from typing import Dict, List
+from typing import Dict, Generator, List, Optional
 
 from lsprotocol.types import (
     CodeAction,
@@ -64,6 +64,34 @@ def pylsp_settings():
     return converter.unstructure(settings)
 
 
+@hookimpl(hookwrapper=True)
+def pylsp_format_document(workspace: Workspace, document: Document) -> Generator:
+    """
+    Provide formatting through ruff.
+
+    Parameters
+    ----------
+    workspace : pylsp.workspace.Workspace
+        Current workspace.
+    document : pylsp.workspace.Document
+        Document to apply ruff on.
+    """
+    log.debug(f"textDocument/formatting: {document}")
+    outcome = yield
+    results = outcome.get_result()
+    if results:
+        document.source = results[0]["new_text"]
+
+    new_text = run_ruff_format(workspace, document)
+    range = Range(
+        start=Position(line=0, character=0),
+        end=Position(line=len(document.lines), character=0),
+    )
+    text_edit = TextEdit(range=range, new_text=new_text)
+
+    outcome.force_result(converter.unstructure([text_edit]))
+
+
 @hookimpl
 def pylsp_lint(workspace: Workspace, document: Document) -> List[Dict]:
     """
@@ -315,7 +343,20 @@ def run_ruff_fix(workspace: Workspace, document: Document) -> str:
     return result
 
 
-def run_ruff(workspace: Workspace, document: Document, fix: bool = False) -> str:
+def run_ruff_format(workspace: Workspace, document: Document) -> str:
+    settings = load_settings(workspace, document)
+    settings.select = settings.format
+    settings.extend_select = None
+    result = run_ruff(workspace, document, settings=settings, fix=True)
+    return result
+
+
+def run_ruff(
+    workspace: Workspace,
+    document: Document,
+    settings: Optional[PluginSettings] = None,
+    fix: bool = False,
+) -> str:
     """
     Run ruff on the given document and the given arguments.
 
@@ -332,7 +373,8 @@ def run_ruff(workspace: Workspace, document: Document, fix: bool = False) -> str
     -------
     String containing the result in json format.
     """
-    settings = load_settings(workspace, document)
+    if settings is None:
+        settings = load_settings(workspace, document)
     executable = settings.executable
     arguments = build_arguments(document, settings, fix)
 
@@ -456,6 +498,7 @@ def load_settings(workspace: Workspace, document: Document) -> PluginSettings:
             executable=plugin_settings.executable,
             extend_ignore=plugin_settings.extend_ignore,
             extend_select=plugin_settings.extend_select,
+            format=plugin_settings.format,
         )
 
     return plugin_settings

pylsp_ruff/settings.py

@@ -22,6 +22,8 @@ class PluginSettings:
     extend_ignore: Optional[List[str]] = None
     per_file_ignores: Optional[Dict[str, List[str]]] = None
 
+    format: Optional[List[str]] = None
+
 
 def to_camel_case(snake_str: str) -> str:
     components = snake_str.split("_")