cairo-language-server 2.18.0

The Cairo Language Server
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

pub mod cairo_project_toml;
pub mod client_capabilities;
pub mod cursor;
pub mod diagnostics;
pub mod fixture;
pub mod insta;
pub mod itertools;
mod mock_client;
pub mod normalize;
pub mod scarb;
pub mod transform;

use serde_json::Value;

pub use self::cursor::cursors;
pub(crate) use self::fixture::fixture;
pub use self::mock_client::MockClient;

/// Create a sandboxed environment for testing language server features.
///
/// This macro creates a [`fixture::Fixture`] first and sets it up, according to the provided
/// properties, and then runs a [`MockClient`] on it.
///
/// See actual tests for usage examples.
macro_rules! sandbox {
    (
        $(fixture = $fixture:expr;)?
        $(files { $($file:expr => $content:expr),* $(,)? })?
        $(cwd = $cwd:expr;)?
        $(client_capabilities = $client_capabilities:expr;)?
        $(workspace_configuration = $overriding_workspace_configuration:expr;)?
    ) => {{
        use $crate::support::{
            client_capabilities,
            fixture::Fixture,
            MockClient
        };

        #[allow(unused_assignments, unused_mut)]
        let mut fixture = Fixture::new();

        $(fixture = $fixture;)?

        fixture.add_tool_versions();

        $($(fixture.add_file($file, $content);)*)?


        #[allow(unused_mut)]
        let mut client_capabilities = client_capabilities::base();

        #[allow(unused_assignments, unused_mut)]
        let mut workspace_configuration = serde_json::json!({
            "cairo1": {
                "enableProcMacros": false,
                "enableLinter": false
            }
        });

        $(
            use $crate::support::merge_json;

            merge_json(&mut workspace_configuration, &$overriding_workspace_configuration);
        )?
        client_capabilities =
                client_capabilities::with_workspace_configuration(client_capabilities, true);

        $(
            client_capabilities = $client_capabilities(client_capabilities);
        )?

        let client = MockClient::start(fixture, client_capabilities, workspace_configuration, $crate::support::cwd_to_option!($($cwd)?));

        client
    }};
}

#[doc(hidden)]
/// Merges `b`'s kv pairs into `a`, potentially overriding the previous values
/// It takes nested maps into account, descending recursively to achieve merging nested objects
pub(crate) fn merge_json(a: &mut Value, b: &Value) {
    if let (Value::Object(a_map), Value::Object(b_map)) = (a, b) {
        for (k, v) in b_map {
            let v_in_a = a_map.get_mut(k);
            if let Some(value) = v_in_a
                && value.is_object()
            {
                merge_json(value, b_map.get(k).unwrap_or(&Value::Object(Default::default())));
                continue;
            }
            a_map.insert(k.clone(), v.clone());
        }
    } else {
        panic!("Non-object Value merging is not supported.");
    }
}

pub(crate) use sandbox;

macro_rules! cwd_to_option {
    () => {{ Option::<&'static str>::None }};
    ($cwd:expr) => {{ Some($cwd) }};
}

pub(crate) use cwd_to_option;