php-lsp 0.18.1

A PHP Language Server Protocol implementation
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
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
//! Code actions for arrow function ↔ closure conversions:
//! - "Convert to arrow function": closure with single `return` → arrow function
//! - "Convert to closure": arrow function → closure with `{ return …; }`

use super::*;
use expect_test::expect;

// --- Offered ---

#[tokio::test]
async fn arrow_fn_offered_for_simple_closure() {
    let mut s = TestServer::new().await;
    s.validate_syntax(false);
    let out = s
        .check_code_actions(
            r#"<?php
$fn = $0function() { return 42; }$0;
"#,
        )
        .await;
    assert!(
        out.contains("Convert to arrow function"),
        "expected action in: {out}"
    );
}

#[tokio::test]
async fn arrow_fn_offered_when_cursor_anywhere_in_closure() {
    let mut s = TestServer::new().await;
    s.validate_syntax(false);
    // Cursor in the middle of the body, not on `function` keyword.
    let out = s
        .check_code_actions(
            r#"<?php
$fn = function() { return $042; };
"#,
        )
        .await;
    assert!(
        out.contains("Convert to arrow function"),
        "expected action in: {out}"
    );
}

// --- Not offered ---

#[tokio::test]
async fn arrow_fn_not_offered_for_multi_statement_body() {
    let mut s = TestServer::new().await;
    s.validate_syntax(false);
    let out = s
        .check_code_actions(
            r#"<?php
$fn = $0function($x) {
    $y = $x * 2;
    return $y;
}$0;
"#,
        )
        .await;
    assert!(
        !out.contains("Convert to arrow function"),
        "should not offer for multi-statement body, got: {out}"
    );
}

#[tokio::test]
async fn arrow_fn_not_offered_when_body_is_not_return() {
    let mut s = TestServer::new().await;
    s.validate_syntax(false);
    let out = s
        .check_code_actions(
            r#"<?php
$fn = $0function($x) { echo $x; }$0;
"#,
        )
        .await;
    assert!(
        !out.contains("Convert to arrow function"),
        "should not offer when body is not return, got: {out}"
    );
}

#[tokio::test]
async fn arrow_fn_not_offered_for_by_ref_use_capture() {
    let mut s = TestServer::new().await;
    s.validate_syntax(false);
    let out = s
        .check_code_actions(
            r#"<?php
$counter = 0;
$fn = $0function() use (&$counter) { return $counter; }$0;
"#,
        )
        .await;
    assert!(
        !out.contains("Convert to arrow function"),
        "should not offer for by-ref use capture, got: {out}"
    );
}

// --- Applied edits ---

#[tokio::test]
async fn arrow_fn_converts_no_param_closure() {
    let mut s = TestServer::new().await;
    s.validate_syntax(false);
    let out = s
        .check_code_action_apply(
            r#"<?php
$fn = $0function() { return 42; }$0;
"#,
            "Convert to arrow function",
        )
        .await;
    expect![[r#"
        <?php
        $fn = fn() => 42;
    "#]]
    .assert_eq(&out);
}

#[tokio::test]
async fn arrow_fn_converts_closure_with_params() {
    let mut s = TestServer::new().await;
    s.validate_syntax(false);
    let out = s
        .check_code_action_apply(
            r#"<?php
$fn = $0function(int $x, int $y) { return $x + $y; }$0;
"#,
            "Convert to arrow function",
        )
        .await;
    expect![[r#"
        <?php
        $fn = fn(int $x, int $y) => $x + $y;
    "#]]
    .assert_eq(&out);
}

#[tokio::test]
async fn arrow_fn_converts_closure_with_return_type() {
    let mut s = TestServer::new().await;
    s.validate_syntax(false);
    let out = s
        .check_code_action_apply(
            r#"<?php
$fn = $0function(string $s): string { return strtoupper($s); }$0;
"#,
            "Convert to arrow function",
        )
        .await;
    expect![[r#"
        <?php
        $fn = fn(string $s): string => strtoupper($s);
    "#]]
    .assert_eq(&out);
}

#[tokio::test]
async fn arrow_fn_converts_static_closure() {
    let mut s = TestServer::new().await;
    s.validate_syntax(false);
    let out = s
        .check_code_action_apply(
            r#"<?php
$fn = $0static function(int $n): int { return $n * 2; }$0;
"#,
            "Convert to arrow function",
        )
        .await;
    expect![[r#"
        <?php
        $fn = static fn(int $n): int => $n * 2;
    "#]]
    .assert_eq(&out);
}

#[tokio::test]
async fn arrow_fn_drops_value_use_clause() {
    let mut s = TestServer::new().await;
    s.validate_syntax(false);
    let out = s
        .check_code_action_apply(
            r#"<?php
$base = 10;
$fn = $0function(int $x) use ($base) { return $x + $base; }$0;
"#,
            "Convert to arrow function",
        )
        .await;
    expect![[r#"
        <?php
        $base = 10;
        $fn = fn(int $x) => $x + $base;
    "#]]
    .assert_eq(&out);
}

#[tokio::test]
async fn arrow_fn_converts_closure_inside_array_map() {
    let mut s = TestServer::new().await;
    s.validate_syntax(false);
    let out = s
        .check_code_action_apply(
            r#"<?php
$result = array_map($0function(int $n) { return $n * $n; }$0, $items);
"#,
            "Convert to arrow function",
        )
        .await;
    expect![[r#"
        <?php
        $result = array_map(fn(int $n) => $n * $n, $items);
    "#]]
    .assert_eq(&out);
}

#[tokio::test]
async fn arrow_fn_converts_innermost_nested_closure() {
    let mut s = TestServer::new().await;
    s.validate_syntax(false);
    let out = s
        .check_code_action_apply(
            r#"<?php
$outer = function(int $a) {
    return $0function(int $b) { return $a + $b; }$0;
};
"#,
            "Convert to arrow function",
        )
        .await;
    expect![[r#"
        <?php
        $outer = function(int $a) {
            return fn(int $b) => $a + $b;
        };
    "#]]
    .assert_eq(&out);
}

#[tokio::test]
async fn arrow_fn_with_nullable_return_type() {
    let mut s = TestServer::new().await;
    s.validate_syntax(false);
    let out = s
        .check_code_action_apply(
            r#"<?php
$fn = $0function(?string $s): ?string { return $s; }$0;
"#,
            "Convert to arrow function",
        )
        .await;
    expect![[r#"
        <?php
        $fn = fn(?string $s): ?string => $s;
    "#]]
    .assert_eq(&out);
}

// ── Convert to closure ────────────────────────────────────────────────────────

// --- Offered ---

#[tokio::test]
async fn to_closure_offered_for_simple_arrow_function() {
    let mut s = TestServer::new().await;
    s.validate_syntax(false);
    let out = s
        .check_code_actions(
            r#"<?php
$fn = $0fn() => 42$0;
"#,
        )
        .await;
    assert!(
        out.contains("Convert to closure"),
        "expected action in: {out}"
    );
}

#[tokio::test]
async fn to_closure_offered_when_cursor_inside_body() {
    let mut s = TestServer::new().await;
    s.validate_syntax(false);
    let out = s
        .check_code_actions(
            r#"<?php
$fn = fn($x) => $0$x * 2;
"#,
        )
        .await;
    assert!(
        out.contains("Convert to closure"),
        "expected action in: {out}"
    );
}

// --- Not offered ---

#[tokio::test]
async fn to_closure_not_offered_when_cursor_is_outside() {
    let mut s = TestServer::new().await;
    s.validate_syntax(false);
    // Cursor is before the fn keyword
    let out = s
        .check_code_actions(
            r#"<?php
$fn$0 = fn() => 42;
"#,
        )
        .await;
    assert!(
        !out.contains("Convert to closure"),
        "should not offer when cursor is outside arrow function, got: {out}"
    );
}

// --- Applied edits ---

#[tokio::test]
async fn to_closure_converts_no_param_arrow() {
    let mut s = TestServer::new().await;
    s.validate_syntax(false);
    let out = s
        .check_code_action_apply(
            r#"<?php
$fn = $0fn() => 42$0;
"#,
            "Convert to closure",
        )
        .await;
    expect![[r#"
        <?php
        $fn = function() { return 42; };
    "#]]
    .assert_eq(&out);
}

#[tokio::test]
async fn to_closure_converts_arrow_with_params() {
    let mut s = TestServer::new().await;
    s.validate_syntax(false);
    let out = s
        .check_code_action_apply(
            r#"<?php
$fn = $0fn(int $x, int $y) => $x + $y$0;
"#,
            "Convert to closure",
        )
        .await;
    expect![[r#"
        <?php
        $fn = function(int $x, int $y) { return $x + $y; };
    "#]]
    .assert_eq(&out);
}

#[tokio::test]
async fn to_closure_converts_arrow_with_return_type() {
    let mut s = TestServer::new().await;
    s.validate_syntax(false);
    let out = s
        .check_code_action_apply(
            r#"<?php
$fn = $0fn(string $s): string => strtoupper($s)$0;
"#,
            "Convert to closure",
        )
        .await;
    expect![[r#"
        <?php
        $fn = function(string $s): string { return strtoupper($s); };
    "#]]
    .assert_eq(&out);
}

#[tokio::test]
async fn to_closure_converts_static_arrow() {
    let mut s = TestServer::new().await;
    s.validate_syntax(false);
    let out = s
        .check_code_action_apply(
            r#"<?php
$fn = $0static fn(int $n): int => $n * 2$0;
"#,
            "Convert to closure",
        )
        .await;
    expect![[r#"
        <?php
        $fn = static function(int $n): int { return $n * 2; };
    "#]]
    .assert_eq(&out);
}

#[tokio::test]
async fn to_closure_converts_arrow_inside_array_map() {
    let mut s = TestServer::new().await;
    s.validate_syntax(false);
    let out = s
        .check_code_action_apply(
            r#"<?php
$result = array_map($0fn(int $n) => $n * $n$0, $items);
"#,
            "Convert to closure",
        )
        .await;
    expect![[r#"
        <?php
        $result = array_map(function(int $n) { return $n * $n; }, $items);
    "#]]
    .assert_eq(&out);
}

/// The inner arrow function reads `$a` from the outer scope — arrow functions
/// auto-capture that for free, but a plain closure needs an explicit
/// `use ($a)` or `$a` is undefined at runtime. Converting must synthesize it.
#[tokio::test]
async fn to_closure_converts_innermost_nested_arrow() {
    let mut s = TestServer::new().await;
    s.validate_syntax(false);
    let out = s
        .check_code_action_apply(
            r#"<?php
$outer = fn($a) => $0fn($b) => $a + $b$0;
"#,
            "Convert to closure",
        )
        .await;
    expect![[r#"
        <?php
        $outer = fn($a) => function($b) use ($a) { return $a + $b; };
    "#]]
    .assert_eq(&out);
}

/// Same use-clause requirement as above, with the outer scope being a plain
/// closure's parameter rather than another arrow function's.
#[tokio::test]
async fn to_closure_converts_arrow_inside_closure_body() {
    let mut s = TestServer::new().await;
    s.validate_syntax(false);
    let out = s
        .check_code_action_apply(
            r#"<?php
$outer = function(int $a) {
    return $0fn(int $b) => $a + $b$0;
};
"#,
            "Convert to closure",
        )
        .await;
    expect![[r#"
        <?php
        $outer = function(int $a) {
            return function(int $b) use ($a) { return $a + $b; };
        };
    "#]]
    .assert_eq(&out);
}

/// Multiple distinct outer-scope reads must all land in the use clause, in
/// first-appearance order, deduped (`$a` appears twice).
#[tokio::test]
async fn to_closure_captures_multiple_outer_variables() {
    let mut s = TestServer::new().await;
    s.validate_syntax(false);
    let out = s
        .check_code_action_apply(
            r#"<?php
function make($a, $b, $c) {
    return $0fn($x) => $a + $b * $x + $a - $c$0;
}
"#,
            "Convert to closure",
        )
        .await;
    expect![[r#"
        <?php
        function make($a, $b, $c) {
            return function($x) use ($a, $b, $c) { return $a + $b * $x + $a - $c; };
        }
    "#]]
    .assert_eq(&out);
}

/// `$this` is always implicitly available in a non-static closure — it must
/// never be added to the synthesized `use` clause (`use ($this)` is a PHP
/// fatal error).
#[tokio::test]
async fn to_closure_does_not_capture_this() {
    let mut s = TestServer::new().await;
    s.validate_syntax(false);
    let out = s
        .check_code_action_apply(
            r#"<?php
class Greeter {
    public string $name = "World";
    public function make() {
        return $0fn() => "Hello, {$this->name}"$0;
    }
}
"#,
            "Convert to closure",
        )
        .await;
    expect![[r#"
        <?php
        class Greeter {
            public string $name = "World";
            public function make() {
                return function() { return "Hello, {$this->name}"; };
            }
        }
    "#]]
    .assert_eq(&out);
}

#[tokio::test]
async fn to_closure_with_nullable_return_type() {
    let mut s = TestServer::new().await;
    s.validate_syntax(false);
    let out = s
        .check_code_action_apply(
            r#"<?php
$fn = $0fn(?string $s): ?string => $s$0;
"#,
            "Convert to closure",
        )
        .await;
    expect![[r#"
        <?php
        $fn = function(?string $s): ?string { return $s; };
    "#]]
    .assert_eq(&out);
}