glua_ls 1.0.27

Language server for Garry's Mod Lua (GLua).
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

#[cfg(test)]
mod tests {
    use crate::handlers::test_lib::{ProviderVirtualWorkspace, VirtualSignatureHelp, check};
    use googletest::prelude::*;

    #[gtest]
    fn test_1() -> Result<()> {
        let mut ws = ProviderVirtualWorkspace::new();
        check!(ws.check_signature_helper(
            r#"
                ---@class Action
                ---@field id fun(self:Action, itemId:integer, ...:integer?):boolean
                ---@overload fun():Action
                Action = {}

                Action:id(1, <??>)
            "#,
            VirtualSignatureHelp {
                target_label: "Action:id(itemId: integer, ...: integer?): boolean".to_string(),
                active_signature: 0,
                active_parameter: 1,
            },
        ));
        Ok(())
    }

    #[gtest]
    fn test_1_manual_invoke_on_arg() -> Result<()> {
        let mut ws = ProviderVirtualWorkspace::new();
        check!(ws.check_signature_helper(
            r#"
                ---@class Action
                ---@field id fun(self:Action, itemId:integer, ...:integer?):boolean
                ---@overload fun():Action
                Action = {}

                Action:id(1, ar<??>)
            "#,
            VirtualSignatureHelp {
                target_label: "Action:id(itemId: integer, ...: integer?): boolean".to_string(),
                active_signature: 0,
                active_parameter: 1,
            },
        ));
        Ok(())
    }

    #[gtest]
    fn test_2() -> Result<()> {
        let mut ws = ProviderVirtualWorkspace::new_with_init_std_lib();
        check!(ws.check_signature_helper(
            r#"
                ---@param path string
                local function readFile(path)
                end

                pcall(readFile, <??>)
            "#,
            VirtualSignatureHelp {
                target_label: "pcall(f: sync fun(path: string), path: string): boolean".to_string(),
                active_signature: 0,
                active_parameter: 1,
            },
        ));
        Ok(())
    }

    #[gtest]
    fn test_callback_signature_help() -> Result<()> {
        let mut ws = ProviderVirtualWorkspace::new();
        check!(ws.check_signature_helper(
            r#"
                ---@class EventData
                ---@field name string

                ---@class EventDispatcher
                ---@field pre fun(self:EventDispatcher,callback:fun(context:EventData))
                local EventDispatcher = {}

                EventDispatcher:pre(function(<??>)
                end)
            "#,
            VirtualSignatureHelp {
                target_label: "callback(context: EventData)".to_string(),
                active_signature: 0,
                active_parameter: 0,
            },
        ));
        Ok(())
    }

    #[gtest]
    fn test_callback_signature_help_2() -> Result<()> {
        let mut ws = ProviderVirtualWorkspace::new();
        check!(ws.check_signature_helper(
            r#"
                ---@class EventData
                ---@field name string

                ---@class EventDispatcher
                ---@field pre fun(self:EventDispatcher,callback:fun(context:EventData, other: string))
                local EventDispatcher = {}

                EventDispatcher:pre(function(context, <??>)
                end)
            "#,
            VirtualSignatureHelp {
                target_label: "callback(context: EventData, other: string)".to_string(),
                active_signature: 0,
                active_parameter: 1,
            },
        ));
        Ok(())
    }

    #[gtest]
    fn test_callback_signature_help_3() -> Result<()> {
        let mut ws = ProviderVirtualWorkspace::new();
        check!(ws.check_signature_helper(
            r#"
                ---@class EventData
                ---@field name string

                ---@class EventDispatcher
                ---@field pre fun(self:EventDispatcher,callback:fun(context:EventData, other: string))
                local EventDispatcher = {}

                EventDispatcher:pre(function(context, oth<??>)
                end)
            "#,
            VirtualSignatureHelp {
                target_label: "callback(context: EventData, other: string)".to_string(),
                active_signature: 0,
                active_parameter: 1,
            },
        ));
        Ok(())
    }

    #[gtest]
    fn test_gmod_hook_add_signature_help() -> Result<()> {
        let mut ws = ProviderVirtualWorkspace::new();
        let mut emmyrc = ws.get_emmyrc();
        emmyrc.gmod.enabled = true;
        ws.update_emmyrc(emmyrc);

        check!(ws.check_signature_helper(
            r#"
                ---@class hook
                hook = {}

                ---@param eventName string
                ---@param identifier any
                ---@param func function
                function hook.Add(eventName, identifier, func) end

                ---@class GM
                GM = {}

                ---@hook PlayerInitialSpawn
                ---@param ply Player
                ---@param transition boolean
                function GM:PlayerInitialSpawn(ply, transition) end

                hook.Add("PlayerInitialSpawn", "id", function(ply, <??>)
                end)
            "#,
            VirtualSignatureHelp {
                target_label: "callback(ply: Player, transition: boolean)".to_string(),
                active_signature: 0,
                active_parameter: 1,
            },
        ));
        Ok(())
    }
}