Make import sorting opt-in

Author: mmcshane

README.md

@@ -72,7 +72,7 @@ the valid configuration keys:
  - `pylsp.plugins.ruff.perFileIgnores`: File-specific error codes to be ignored.
  - `pylsp.plugins.ruff.select`: List of error codes to enable.
  - `pylsp.plugins.ruff.extendSelect`: Same as select, but append to existing error codes.
- - `pylsp.plugins.ruff.format`: List of error codes to fix during formatting. The default is `["I"]`, any additional codes are appended to this list.
+ - `pylsp.plugins.ruff.format`: List of error codes to fix during formatting. Empty by default, use `["I"]` here to get import sorting as part of formatting.
  - `pylsp.plugins.ruff.unsafeFixes`: boolean that enables/disables fixes that are marked "unsafe" by `ruff`. `false` by default.
  - `pylsp.plugins.ruff.severities`: Dictionary of custom severity levels for specific codes, see [below](#custom-severities).
 

pylsp_ruff/plugin.py

@@ -5,7 +5,7 @@
 import sys
 from pathlib import PurePath
 from subprocess import PIPE, Popen
-from typing import Dict, Final, Generator, List, Optional
+from typing import Dict, Generator, List, Optional
 
 if sys.version_info >= (3, 11):
     import tomllib
@@ -62,8 +62,6 @@
     "H": DiagnosticSeverity.Hint,
 }
 
-ISORT_FIXES: Final = "I"
-
 
 class Subcommand(str, enum.Enum):
     CHECK = "check"
@@ -130,15 +128,16 @@ def pylsp_format_document(workspace: Workspace, document: Document) -> Generator
         settings=settings, document_path=document.path, document_source=source
     )
 
-    settings.select = [ISORT_FIXES]
     if settings.format:
-        settings.select.extend(settings.format)
-    new_text = run_ruff(
-        settings=settings,
-        document_path=document.path,
-        document_source=new_text,
-        fix=True,
-    )
+        # A second pass on the document via `ruff check` with only the rules
+        # enabled via the format config. This allows for things liek specifying
+        # `format = ["I"]` to get import sorting as part of formatting.
+        new_text = run_ruff(
+            settings=PluginSettings(ignore=["ALL"], select=settings.format),
+            document_path=document.path,
+            document_source=new_text,
+            fix=True,
+        )
 
     # Avoid applying empty text edit
     if not new_text or new_text == source:

tests/test_ruff_format.py

@@ -11,6 +11,41 @@
 
 import pylsp_ruff.plugin as plugin
 
+_UNSORTED_IMPORTS = tw.dedent(
+    """
+    from thirdparty import x
+    import io
+    import asyncio
+    """
+).strip()
+
+_SORTED_IMPORTS = tw.dedent(
+    """
+    import asyncio
+    import io
+
+    from thirdparty import x
+    """
+).strip()
+
+_UNFORMATTED_CODE = tw.dedent(
+    """
+    def foo(): pass
+    def bar(): pass
+    """
+).strip()
+
+_FORMATTED_CODE = tw.dedent(
+    """
+    def foo():
+        pass
+
+
+    def bar():
+        pass
+    """
+).strip()
+
 
 @pytest.fixture()
 def workspace(tmp_path):
@@ -54,40 +89,26 @@ def force_result(self, r):
     return pytest.fail()
 
 
-def test_ruff_format(workspace):
-    # imports incorrectly ordered,
-    # body of foo has a line that's too long
-    # def bar() line missing whitespace above
-    txt = tw.dedent(
-        """
-        from thirdparty import x
-        import io
-        import asyncio
-
-        def foo():
-            print("this is a looooooooooooooooooooooooooooooooooooooooooooong line that should exceed the usual line-length limit which is normally eighty-eight columns")
-        def bar():
-            pass
-        """  # noqa: E501
-    ).lstrip()
-    want = tw.dedent(
-        """
-        import asyncio
-        import io
-
-        from thirdparty import x
-
-
-        def foo():
-            print(
-                "this is a looooooooooooooooooooooooooooooooooooooooooooong line that should exceed the usual line-length limit which is normally eighty-eight columns"
-            )
-
-
-        def bar():
-            pass
-        """  # noqa: E501
-    ).lstrip()
+def test_ruff_format_only(workspace):
+    txt = f"{_UNSORTED_IMPORTS}\n{_UNFORMATTED_CODE}"
+    want = f"{_UNSORTED_IMPORTS}\n\n\n{_FORMATTED_CODE}\n"
+    _, doc = temp_document(txt, workspace)
+    got = run_plugin_format(workspace, doc)
+    assert want == got
+
+
+def test_ruff_format_and_sort_imports(workspace):
+    txt = f"{_UNSORTED_IMPORTS}\n{_UNFORMATTED_CODE}"
+    want = f"{_SORTED_IMPORTS}\n\n\n{_FORMATTED_CODE}\n"
     _, doc = temp_document(txt, workspace)
+    workspace._config.update(
+        {
+            "plugins": {
+                "ruff": {
+                    "format": ["I001"],
+                }
+            }
+        }
+    )
     got = run_plugin_format(workspace, doc)
-    assert want == got, f"want:\n{want}\n\ngot:\n{got}"
+    assert want == got