lsp-bridge 0.2.0

A comprehensive Rust library that provides a bridge between Language Server Protocol (LSP) servers and clients
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
//! Configuration types and builders for LSP Bridge.

use crate::error::{LspError, Result};
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use std::path::{Path, PathBuf};
use std::time::Duration;

/// Configuration for an LSP server instance.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct LspServerConfig {
    /// Command to execute the LSP server
    pub command: String,

    /// Arguments to pass to the server command
    pub args: Vec<String>,

    /// Working directory for the server process
    pub working_directory: Option<PathBuf>,

    /// Environment variables for the server process
    pub environment: HashMap<String, String>,

    /// Root path/URI for the workspace
    pub root_path: Option<PathBuf>,

    /// Workspace folders
    pub workspace_folders: Vec<PathBuf>,

    /// Initialization options to send to the server
    pub initialization_options: Option<serde_json::Value>,

    /// Client capabilities to advertise
    pub client_capabilities: LspClientCapabilities,

    /// Server startup timeout
    pub startup_timeout: Duration,

    /// Request timeout
    pub request_timeout: Duration,

    /// Whether to enable tracing
    pub trace: TraceLevel,

    /// Custom server settings
    pub settings: HashMap<String, serde_json::Value>,

    /// Maximum number of restart attempts
    pub max_restart_attempts: u32,

    /// Restart delay between attempts
    pub restart_delay: Duration,
}

impl Default for LspServerConfig {
    fn default() -> Self {
        Self {
            command: String::new(),
            args: Vec::new(),
            working_directory: None,
            environment: HashMap::new(),
            root_path: None,
            workspace_folders: Vec::new(),
            initialization_options: None,
            client_capabilities: LspClientCapabilities::default(),
            startup_timeout: Duration::from_secs(30),
            request_timeout: Duration::from_secs(30),
            trace: TraceLevel::Off,
            settings: HashMap::new(),
            max_restart_attempts: 3,
            restart_delay: Duration::from_secs(2),
        }
    }
}

impl LspServerConfig {
    /// Create a new server configuration
    pub fn new() -> Self {
        Self::default()
    }

    /// Set the server command
    pub fn command<S: Into<String>>(mut self, command: S) -> Self {
        self.command = command.into();
        self
    }

    /// Add arguments to the server command
    pub fn args<I, S>(mut self, args: I) -> Self
    where
        I: IntoIterator<Item = S>,
        S: Into<String>,
    {
        self.args.extend(args.into_iter().map(|s| s.into()));
        self
    }

    /// Add a single argument to the server command
    pub fn arg<S: Into<String>>(mut self, arg: S) -> Self {
        self.args.push(arg.into());
        self
    }

    /// Set the working directory
    pub fn working_directory<P: AsRef<Path>>(mut self, path: P) -> Self {
        self.working_directory = Some(path.as_ref().to_path_buf());
        self
    }

    /// Add an environment variable
    pub fn env<K, V>(mut self, key: K, value: V) -> Self
    where
        K: Into<String>,
        V: Into<String>,
    {
        self.environment.insert(key.into(), value.into());
        self
    }

    /// Set multiple environment variables
    pub fn envs<I, K, V>(mut self, vars: I) -> Self
    where
        I: IntoIterator<Item = (K, V)>,
        K: Into<String>,
        V: Into<String>,
    {
        for (key, value) in vars {
            self.environment.insert(key.into(), value.into());
        }
        self
    }

    /// Set the root path
    pub fn root_path<P: AsRef<Path>>(mut self, path: P) -> Self {
        self.root_path = Some(path.as_ref().to_path_buf());
        self
    }

    /// Add workspace folders
    pub fn workspace_folders<I, P>(mut self, folders: I) -> Self
    where
        I: IntoIterator<Item = P>,
        P: AsRef<Path>,
    {
        self.workspace_folders
            .extend(folders.into_iter().map(|p| p.as_ref().to_path_buf()));
        self
    }

    /// Add a single workspace folder
    pub fn workspace_folder<P: AsRef<Path>>(mut self, folder: P) -> Self {
        self.workspace_folders.push(folder.as_ref().to_path_buf());
        self
    }

    /// Set initialization options
    pub fn initialization_options(mut self, options: serde_json::Value) -> Self {
        self.initialization_options = Some(options);
        self
    }

    /// Set client capabilities
    pub fn client_capabilities(mut self, capabilities: LspClientCapabilities) -> Self {
        self.client_capabilities = capabilities;
        self
    }

    /// Set startup timeout
    pub fn startup_timeout(mut self, timeout: Duration) -> Self {
        self.startup_timeout = timeout;
        self
    }

    /// Set request timeout
    pub fn request_timeout(mut self, timeout: Duration) -> Self {
        self.request_timeout = timeout;
        self
    }

    /// Set trace level
    pub fn trace(mut self, level: TraceLevel) -> Self {
        self.trace = level;
        self
    }

    /// Add a server setting
    pub fn setting<K, V>(mut self, key: K, value: V) -> Self
    where
        K: Into<String>,
        V: Serialize,
    {
        if let Ok(json_value) = serde_json::to_value(value) {
            self.settings.insert(key.into(), json_value);
        }
        self
    }

    /// Set maximum restart attempts
    pub fn max_restart_attempts(mut self, attempts: u32) -> Self {
        self.max_restart_attempts = attempts;
        self
    }

    /// Set restart delay
    pub fn restart_delay(mut self, delay: Duration) -> Self {
        self.restart_delay = delay;
        self
    }

    /// Validate the configuration
    pub fn validate(&self) -> Result<()> {
        if self.command.is_empty() {
            return Err(LspError::invalid_configuration("Command cannot be empty").into());
        }

        if self.startup_timeout.is_zero() {
            return Err(LspError::invalid_configuration(
                "Startup timeout must be greater than zero",
            )
            .into());
        }

        if self.request_timeout.is_zero() {
            return Err(LspError::invalid_configuration(
                "Request timeout must be greater than zero",
            )
            .into());
        }

        Ok(())
    }
}

/// Client capabilities configuration.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct LspClientCapabilities {
    /// Text document capabilities
    pub text_document: TextDocumentClientCapabilities,

    /// Workspace capabilities
    pub workspace: WorkspaceClientCapabilities,

    /// Window capabilities
    pub window: WindowClientCapabilities,

    /// General capabilities
    pub general: GeneralClientCapabilities,

    /// Experimental capabilities
    pub experimental: Option<serde_json::Value>,
}

/// Text document client capabilities.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct TextDocumentClientCapabilities {
    pub synchronization: Option<TextDocumentSyncClientCapabilities>,
    pub completion: Option<CompletionClientCapabilities>,
    pub hover: Option<HoverClientCapabilities>,
    pub signature_help: Option<SignatureHelpClientCapabilities>,
    pub declaration: Option<GotoCapability>,
    pub definition: Option<GotoCapability>,
    pub type_definition: Option<GotoCapability>,
    pub implementation: Option<GotoCapability>,
    pub references: Option<ReferenceClientCapabilities>,
    pub document_highlight: Option<DocumentHighlightClientCapabilities>,
    pub document_symbol: Option<DocumentSymbolClientCapabilities>,
    pub code_action: Option<CodeActionClientCapabilities>,
    pub code_lens: Option<CodeLensClientCapabilities>,
    pub document_link: Option<DocumentLinkClientCapabilities>,
    pub color_provider: Option<DocumentColorClientCapabilities>,
    pub formatting: Option<DocumentFormattingClientCapabilities>,
    pub range_formatting: Option<DocumentRangeFormattingClientCapabilities>,
    pub on_type_formatting: Option<DocumentOnTypeFormattingClientCapabilities>,
    pub rename: Option<RenameClientCapabilities>,
    pub folding_range: Option<FoldingRangeClientCapabilities>,
    pub selection_range: Option<SelectionRangeClientCapabilities>,
    pub publish_diagnostics: Option<PublishDiagnosticsClientCapabilities>,
    pub call_hierarchy: Option<CallHierarchyClientCapabilities>,
}

/// Workspace client capabilities.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct WorkspaceClientCapabilities {
    pub apply_edit: Option<bool>,
    pub workspace_edit: Option<WorkspaceEditClientCapabilities>,
    pub did_change_configuration: Option<DidChangeConfigurationClientCapabilities>,
    pub did_change_watched_files: Option<DidChangeWatchedFilesClientCapabilities>,
    pub symbol: Option<WorkspaceSymbolClientCapabilities>,
    pub execute_command: Option<ExecuteCommandClientCapabilities>,
    pub workspace_folders: Option<bool>,
    pub configuration: Option<bool>,
}

/// Window client capabilities.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct WindowClientCapabilities {
    pub work_done_progress: Option<bool>,
    pub show_message: Option<ShowMessageRequestClientCapabilities>,
    pub show_document: Option<ShowDocumentClientCapabilities>,
}

/// General client capabilities.
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct GeneralClientCapabilities {
    pub regular_expressions: Option<RegularExpressionsClientCapabilities>,
    pub markdown: Option<MarkdownClientCapabilities>,
}

/// Trace level for LSP communication.
#[derive(Debug, Clone, Copy, Serialize, Deserialize)]
pub enum TraceLevel {
    #[serde(rename = "off")]
    Off,
    #[serde(rename = "messages")]
    Messages,
    #[serde(rename = "verbose")]
    Verbose,
}

impl Default for TraceLevel {
    fn default() -> Self {
        Self::Off
    }
}

// Placeholder types for client capabilities - these would normally be imported from lsp-types
// but we're defining minimal versions here for the example

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct TextDocumentSyncClientCapabilities;

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct CompletionClientCapabilities;

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct HoverClientCapabilities;

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct SignatureHelpClientCapabilities;

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct GotoCapability;

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct ReferenceClientCapabilities;

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct DocumentHighlightClientCapabilities;

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct DocumentSymbolClientCapabilities;

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct CodeActionClientCapabilities;

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct CodeLensClientCapabilities;

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct DocumentLinkClientCapabilities;

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct DocumentColorClientCapabilities;

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct DocumentFormattingClientCapabilities;

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct DocumentRangeFormattingClientCapabilities;

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct DocumentOnTypeFormattingClientCapabilities;

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct RenameClientCapabilities;

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct FoldingRangeClientCapabilities;

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct SelectionRangeClientCapabilities;

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct PublishDiagnosticsClientCapabilities;

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct CallHierarchyClientCapabilities;

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct WorkspaceEditClientCapabilities;

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct DidChangeConfigurationClientCapabilities;

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct DidChangeWatchedFilesClientCapabilities;

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct WorkspaceSymbolClientCapabilities;

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct ExecuteCommandClientCapabilities;

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct ShowMessageRequestClientCapabilities;

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct ShowDocumentClientCapabilities;

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct RegularExpressionsClientCapabilities;

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct MarkdownClientCapabilities;

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_server_config_builder() {
        let config = LspServerConfig::new()
            .command("rust-analyzer")
            .arg("--help")
            .root_path("/tmp/project")
            .workspace_folder("/tmp/project/src")
            .startup_timeout(Duration::from_secs(60));

        assert_eq!(config.command, "rust-analyzer");
        assert_eq!(config.args, vec!["--help"]);
        assert_eq!(config.startup_timeout, Duration::from_secs(60));
    }

    #[test]
    fn test_config_validation() {
        let valid_config = LspServerConfig::new().command("test-server");
        assert!(valid_config.validate().is_ok());

        let invalid_config = LspServerConfig::new(); // No command
        assert!(invalid_config.validate().is_err());
    }

    #[test]
    fn test_client_capabilities_default() {
        let capabilities = LspClientCapabilities::default();
        assert!(capabilities.experimental.is_none());
    }
}