lsp 0.1.0

Language Server Protocol
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

//! # Language Server Protocol (LSP)
//!
//! This crate provides types for the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/).
//! It makes no assumptions about the transport layer (e.g. TCP, Unix sockets,
//! etc.), or if the consumer is a client or server.
//!
//! This crate uses [`serde`] for all encodable types, and a custom [`Uri`] type
//! for URIs.
//!
//! # Features
//!
//! - `raw_value` - Use [`serde_json::value::RawValue`] for `LSPAny` instead of
//!   [`serde_json::Value`].
//!
//! # Version
//!
//! Almost all types in this crate are generated from the [LSP
//! model](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/metaModel/metaModel.json).
//! This code was generated from LSP version
#![doc = concat!("**", include_str!("lsp_version.txt"), "**.")]
//!

#![allow(rustdoc::redundant_explicit_links)] // explicit links are simpler
#![allow(deprecated)] // we need to use the deprecated types

pub mod notification;
pub mod request;

mod types;
pub use types::*;

mod uri;
pub use uri::Uri;

#[cfg(not(feature = "raw_value"))]
type Value = serde_json::Value;
#[cfg(feature = "raw_value")]
type Value = Box<serde_json::value::RawValue>;

use serde::{Deserialize, Serialize};

/// Represents a union of two types. The first variant will take priority when
/// deserializing (using `#[serde(untagged)]` behavior). Additionally, the first
/// variant is the default.
///
/// This relies on the LSP spec putting the "default" variant first. Ordering is
/// maintained between unions in the LSP spec and the order of generic arguments
/// in generated code.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum Or2<A, B> {
  A(A),
  B(B),
}

/// Represents a union of three types. The first variant will take priority when
/// deserializing (using `#[serde(untagged)]` behavior). Additionally, the first
/// variant is the default.
///
/// This relies on the LSP spec putting the "default" variant first. Ordering is
/// maintained between unions in the LSP spec and the order of generic arguments
/// in generated code.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum Or3<A, B, C> {
  A(A),
  B(B),
  C(C),
}

impl<A: Default, B> Default for Or2<A, B> {
  fn default() -> Self { Or2::A(A::default()) }
}

impl<A: Default, B, C> Default for Or3<A, B, C> {
  fn default() -> Self { Or3::A(A::default()) }
}

#[derive(serde::Deserialize)]
#[serde(tag = "kind")]
#[serde(rename_all = "camelCase")]
pub enum WorkDoneProgress {
  Begin(WorkDoneProgressBegin),
  Report(WorkDoneProgressReport),
  End(WorkDoneProgressEnd),
}

#[cfg(test)]
mod tests {
  use serde::de::DeserializeOwned;

  use super::*;

  macro_rules! assert_serde {
    ($value:expr, $expected:literal as $ty:ty) => {
      assert_eq!(ser($value), $expected);
      // This is dumb but it works.
      assert_eq!(format!("{:?}", de::<$ty>($expected)), format!("{:?}", $value));
    };
  }

  fn ser<T: Serialize>(t: &T) -> String { serde_json::to_string(t).unwrap() }
  fn de<T: DeserializeOwned>(t: &str) -> T { serde_json::from_str(t).unwrap() }

  #[test]
  fn string_enums_work() {
    assert_serde!(
      &[
        PositionEncodingKind::Utf8,
        PositionEncodingKind::Utf16,
        PositionEncodingKind::Custom("foo".into())
      ],
      r#"["utf-8","utf-16","foo"]"# as Vec<PositionEncodingKind>
    );
  }

  #[test]
  fn empty_caps_works() {
    assert_serde!(&ClientCapabilities::default(), r#"{}"# as ClientCapabilities);
    assert_serde!(&ServerCapabilities::default(), r#"{}"# as ServerCapabilities);
  }

  #[test]
  fn or2_works() {
    assert_serde!(
      &TextDocumentSyncOptions { save: Some(Or2::A(true)), ..Default::default() },
      r#"{"save":true}"# as TextDocumentSyncOptions
    );

    assert_serde!(
      &TextDocumentSyncOptions { save: Some(Or2::B(SaveOptions::default())), ..Default::default() },
      r#"{"save":{}}"# as TextDocumentSyncOptions
    );

    assert_serde!(
      &TextDocumentSyncOptions {
        save: Some(Or2::B(SaveOptions { include_text: Some(true), ..Default::default() })),
        ..Default::default()
      },
      r#"{"save":{"includeText":true}}"# as TextDocumentSyncOptions
    );
  }
}