fix(lsp): don't provide organizeImports action when client provides it (#31530)

Author: nayeemrmn

cli/lsp/config.rs

@@ -1208,6 +1208,14 @@ impl Config {
     })()
     .unwrap_or(false)
   }
+
+  pub fn client_provided_organize_imports_capable(&self) -> bool {
+    (|| {
+      let experimental = self.client_capabilities.experimental.as_ref()?;
+      experimental.get("clientProvidedOrganizeImports")?.as_bool()
+    })()
+    .unwrap_or(false)
+  }
 }
 
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]

cli/lsp/language_server.rs

@@ -2323,8 +2323,9 @@ impl Inner {
     );
 
     // Organize imports
-    if kinds.is_empty()
-      || kinds.contains(&CodeActionKind::SOURCE_ORGANIZE_IMPORTS)
+    if !self.config.client_provided_organize_imports_capable()
+      && (kinds.is_empty()
+        || kinds.contains(&CodeActionKind::SOURCE_ORGANIZE_IMPORTS))
     {
       let document_has_errors = params.context.diagnostics.iter().any(|d| {
         // Assume diagnostics without a severity are errors

tests/integration/lsp_tests.rs

@@ -8033,6 +8033,47 @@ console.log(other, submodule);
   client.shutdown();
 }
 
+#[test]
+#[timeout(300_000)]
+fn lsp_code_actions_organize_imports_client_provided_capability() {
+  let context = TestContextBuilder::new().use_temp_cwd().build();
+  let temp_dir = context.temp_dir();
+  let file = temp_dir.source_file(
+    "file.ts",
+    r#"import { z, y } from "./z.ts";
+import { c, a, b } from "./b.ts";
+import { d } from "./a.ts";
+import unused from "./c.ts";
+
+console.log(b, a, c, d, y, z);
+"#,
+  );
+  let uri = file.uri();
+  let mut client = context.new_lsp_command().build();
+  client.initialize(|builder| {
+    builder.enable_client_provided_organize_imports();
+  });
+  client.did_open_file(&file);
+
+  // Request "Organize Imports" action
+  let res = client.write_request(
+    "textDocument/codeAction",
+    json!({
+      "textDocument": { "uri": uri },
+      "range": {
+        "start": { "line": 0, "character": 0 },
+        "end": { "line": 0, "character": 0 }
+      },
+      "context": {
+        "diagnostics": [],
+        "only": ["source.organizeImports"]
+      }
+    }),
+  );
+  assert_eq!(res, json!(null));
+  client.shutdown();
+}
+
 #[test]
 #[timeout(300_000)]
 fn lsp_code_actions_refactor_no_disabled_support() {

tests/util/server/src/lsp.rs

@@ -321,6 +321,19 @@ impl InitializeParamsBuilder {
     self
   }
 
+  pub fn enable_client_provided_organize_imports(&mut self) -> &mut Self {
+    let obj = self
+      .params
+      .capabilities
+      .experimental
+      .as_mut()
+      .unwrap()
+      .as_object_mut()
+      .unwrap();
+    obj.insert("clientProvidedOrganizeImports".to_string(), true.into());
+    self
+  }
+
   pub fn set_cache(&mut self, value: impl AsRef<str>) -> &mut Self {
     let options = self.initialization_options_mut();
     options.insert("cache".to_string(), value.as_ref().to_string().into());