feat(lsp): will save

helix-lsp/src/client.rs

@@ -10,8 +10,8 @@ use helix_loader::{self, VERSION_AND_GIT_HASH};
 use helix_stdx::path;
 use lsp::{
     notification::DidChangeWorkspaceFolders, CodeActionCapabilityResolveSupport,
-    DidChangeWorkspaceFoldersParams, OneOf, PositionEncodingKind, SignatureHelp, Url,
-    WorkspaceFolder, WorkspaceFoldersChangeEvent,
+    DidChangeWorkspaceFoldersParams, OneOf, PositionEncodingKind, SignatureHelp,
+    TextDocumentSaveReason, TextEdit, Url, WorkspaceFolder, WorkspaceFoldersChangeEvent,
 };
 use lsp_types as lsp;
 use parking_lot::Mutex;
@@ -33,6 +33,8 @@ use tokio::{
     },
 };
 
+static DOCUMENT_OPS_TIMEOUT: u64 = 5;
+
 fn workspace_for_uri(uri: lsp::Url) -> WorkspaceFolder {
     lsp::WorkspaceFolder {
         name: uri
@@ -264,7 +266,7 @@ impl Client {
             .expect("language server not yet initialized!")
     }
 
-    pub(crate) fn file_operations_intests(&self) -> &FileOperationsInterest {
+    pub(crate) fn file_operations_interest(&self) -> &FileOperationsInterest {
         self.file_operation_interest
             .get_or_init(|| FileOperationsInterest::new(self.capabilities()))
     }
@@ -720,7 +722,7 @@ impl Client {
         new_path: &Path,
         is_dir: bool,
     ) -> Option<impl Future<Output = Result<lsp::WorkspaceEdit>>> {
-        let capabilities = self.file_operations_intests();
+        let capabilities = self.file_operations_interest();
         if !capabilities.will_rename.has_interest(old_path, is_dir) {
             return None;
         }
@@ -738,7 +740,7 @@ impl Client {
         }];
         let request = self.call_with_timeout::<lsp::request::WillRenameFiles>(
             lsp::RenameFilesParams { files },
-            5,
+            DOCUMENT_OPS_TIMEOUT,
         );
 
         Some(async move {
@@ -754,7 +756,7 @@ impl Client {
         new_path: &Path,
         is_dir: bool,
     ) -> Option<impl Future<Output = std::result::Result<(), Error>>> {
-        let capabilities = self.file_operations_intests();
+        let capabilities = self.file_operations_interest();
         if !capabilities.did_rename.has_interest(new_path, is_dir) {
             return None;
         }
@@ -776,6 +778,7 @@ impl Client {
 
     // -------------------------------------------------------------------------------------------
     // Text document
+    // https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_synchronization
     // -------------------------------------------------------------------------------------------
 
     pub fn text_document_did_open(
@@ -960,7 +963,36 @@ impl Client {
         })
     }
 
-    // will_save / will_save_wait_until
+    pub fn text_document_will_save(
+        &self,
+        text_document: lsp::TextDocumentIdentifier,
+    ) -> Option<impl Future<Output = Result<()>>> {
+        Some(self.notify::<lsp::notification::WillSaveTextDocument>(
+            lsp::WillSaveTextDocumentParams {
+                text_document,
+                reason: TextDocumentSaveReason::MANUAL,
+            },
+        ))
+    }
+
+    pub fn text_document_will_save_wait_until(
+        &self,
+        text_document: lsp::TextDocumentIdentifier,
+    ) -> Option<impl Future<Output = Result<Vec<lsp::TextEdit>>>> {
+        let request = self.call_with_timeout::<lsp::request::WillSaveWaitUntil>(
+            lsp::WillSaveTextDocumentParams {
+                text_document,
+                reason: TextDocumentSaveReason::MANUAL,
+            },
+            DOCUMENT_OPS_TIMEOUT,
+        );
+
+        Some(async move {
+            let json = request.await?;
+            let response: Option<Vec<TextEdit>> = serde_json::from_value(json)?;
+            Ok(response.unwrap_or_default())
+        })
+    }
 
     pub fn text_document_did_save(
         &self,
@@ -992,6 +1024,11 @@ impl Client {
         ))
     }
 
+    // -------------------------------------------------------------------------------------------
+    // Language features
+    // https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#languageFeatures
+    // -------------------------------------------------------------------------------------------
+
     pub fn completion(
         &self,
         text_document: lsp::TextDocumentIdentifier,

helix-view/src/document.rs

@@ -1,7 +1,7 @@
 use anyhow::{anyhow, bail, Context, Error};
 use arc_swap::access::DynAccess;
 use arc_swap::ArcSwap;
-use futures_util::future::BoxFuture;
+use futures_util::future::{self, BoxFuture};
 use futures_util::FutureExt;
 use helix_core::auto_pairs::AutoPairs;
 use helix_core::chars::char_is_word;
@@ -871,6 +871,31 @@ impl Document {
         // We encode the file according to the `Document`'s encoding.
         let future = async move {
             use tokio::{fs, fs::File};
+
+            if let Some(identifier) = &identifier {
+                for language_server in language_servers.values() {
+                    let mut notifications = Vec::new();
+
+                    if language_server.is_initialized() {
+                        let Some(notification) =
+                            language_server.text_document_will_save(identifier.clone())
+                        else {
+                            continue
+                        };
+
+                        notifications.push(async move {
+                            if let Err(err) = notification.await {
+                                log::error!(
+                                    "failed to send textDocument/willSave notification: {err:?}"
+                                );
+                            }
+                        });
+                    }
+
+                    future::join_all(notifications).await;
+                }
+            };
+
             if let Some(parent) = path.parent() {
                 // TODO: display a prompt asking the user if the directories should be created
                 if !parent.exists() {
@@ -903,17 +928,27 @@ impl Document {
                 text: text.clone(),
             };
 
-            for (_, language_server) in language_servers {
-                if !language_server.is_initialized() {
-                    return Ok(event);
-                }
-                if let Some(identifier) = &identifier {
-                    if let Some(notification) =
-                        language_server.text_document_did_save(identifier.clone(), &text)
-                    {
-                        notification.await?;
+            if let Some(identifier) = &identifier {
+                let mut notifications = Vec::new();
+                for language_server in language_servers.values() {
+                    if language_server.is_initialized() {
+                        let Some(notification) =
+                            language_server.text_document_did_save(identifier.clone(), &text)
+                        else {
+                            continue
+                        };
+
+                        notifications.push(async move {
+                            if let Err(err) = notification.await {
+                                log::error!(
+                                    "failed to send textDocument/didSave notification: {err:?}"
+                                );
+                            }
+                        });
                     }
                 }
+
+                future::join_all(notifications).await;
             }
 
             Ok(event)