From 55568c48dd82959f58d73fcded630fd5ab8a7cae Mon Sep 17 00:00:00 2001
From: Zanie Blue <contact@zanie.dev>
Date: Thu, 12 Oct 2023 08:38:10 -0500
Subject: [PATCH] Use `--output-format` instead of `--format` (#266)

`--format` is deprecated; includes backwards compatibility so we do not
need to bump the linter version

---------

Co-authored-by: Dhruv Manilawala <dhruvmanila@gmail.com>
---
 ruff_lsp/server.py | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)

diff --git a/ruff_lsp/server.py b/ruff_lsp/server.py
index 538be28..ea7df2a 100755
--- a/ruff_lsp/server.py
+++ b/ruff_lsp/server.py
@@ -113,7 +113,10 @@ class VersionModified(NamedTuple):
 # Require at least Ruff v0.0.291 for formatting, but allow older versions for linting.
 VERSION_REQUIREMENT_FORMATTER = SpecifierSet(">=0.0.291,<0.2.0")
 VERSION_REQUIREMENT_LINTER = SpecifierSet(">=0.0.189,<0.2.0")
+# Version requirement for use of the "ALL" rule selector
 VERSION_REQUIREMENT_ALL_SELECTOR = SpecifierSet(">=0.0.198,<0.2.0")
+# Version requirement for use of the `--output-format` option
+VERSION_REQUIREMENT_OUTPUT_FORMAT = SpecifierSet(">=0.0.291,<0.2.0")
 
 # Arguments provided to every Ruff invocation.
 CHECK_ARGS = [
@@ -121,7 +124,7 @@ class VersionModified(NamedTuple):
     "--no-cache",
     "--no-fix",
     "--quiet",
-    "--format",
+    "--output-format",
     "json",
     "-",
 ]
@@ -155,7 +158,7 @@ class VersionModified(NamedTuple):
     "--watch",
     # Arguments that are not supported at all, and will error when provided.
     # "--stdin-filename",
-    # "--format",
+    # "--output-format",
 ]
 
 # Arguments that are not allowed to be passed to `ruff format`.
@@ -1169,6 +1172,15 @@ async def _run_check_on_document(
         else:
             argv.append(arg)
 
+    # If the Ruff version is not sufficiently recent, use the deprecated `--format`
+    # argument instead of `--output-format`.
+    if not VERSION_REQUIREMENT_OUTPUT_FORMAT.contains(
+        executable.version, prereleases=True
+    ):
+        index = argv.index("--output-format")
+        argv.pop(index)
+        argv.insert(index, "--format")
+
     # If we're trying to run a single rule, add it to the command line, and disable
     # all other rules (if the Ruff version is sufficiently recent).
     if only: