php-lsp 0.2.0

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

//! Code-action tests. Uses the two-`$0` selection DSL so the region
//! requested is literally visible in the fixture.

mod common;

use common::TestServer;
use serde_json::Value;

fn titles(resp: &Value) -> Vec<String> {
    resp["result"]
        .as_array()
        .cloned()
        .unwrap_or_default()
        .iter()
        .filter_map(|a| a["title"].as_str().map(str::to_owned))
        .collect()
}

async fn titles_at_range(server: &mut TestServer, fixture: &str) -> Vec<String> {
    let opened = server.open_fixture(fixture).await;
    let r = opened.range().clone();
    let resp = server.code_action_at(&r).await;
    assert!(resp["error"].is_null(), "codeAction error: {resp:?}");
    titles(&resp)
}

#[tokio::test]
async fn code_action_phpdoc_offered_for_undocumented_function() {
    let mut server = TestServer::new().await;
    let t = titles_at_range(
        &mut server,
        r#"<?php
function $0noDoc$0(int $x): int { return $x; }
"#,
    )
    .await;
    assert!(
        t.iter().any(|s| s.to_lowercase().contains("phpdoc")),
        "expected a PHPDoc action: {t:?}"
    );
}

#[tokio::test]
async fn code_action_extract_variable_offered_on_expression() {
    let mut server = TestServer::new().await;
    let t = titles_at_range(
        &mut server,
        r#"<?php
$result = $01 + 2$0;
"#,
    )
    .await;
    assert!(
        t.iter().any(|s| s.to_lowercase().contains("extract")),
        "expected an Extract action: {t:?}"
    );
}

#[tokio::test]
async fn code_action_generate_constructor_offered_for_class() {
    let mut server = TestServer::new().await;
    let t = titles_at_range(
        &mut server,
        r#"<?php
class $0Point$0 {
    public int $x;
    public int $y;
}
"#,
    )
    .await;
    assert!(
        t.iter().any(|s| s.to_lowercase().contains("constructor")),
        "expected a Generate constructor action: {t:?}"
    );
}

#[tokio::test]
async fn code_action_implement_missing_offered() {
    let mut server = TestServer::new().await;
    // Caret inside the empty class body: use a zero-width selection at
    // column 0 of the `}` line by repeating the marker.
    let t = titles_at_range(
        &mut server,
        r#"<?php
interface Greetable {
    public function greet(): string;
}
class Hello implements Greetable {
$0$0}
"#,
    )
    .await;
    assert!(
        t.iter().any(|s| s.to_lowercase().contains("implement")),
        "expected an Implement action: {t:?}"
    );
}

#[tokio::test]
async fn code_action_add_return_type_offered() {
    let mut server = TestServer::new().await;
    let t = titles_at_range(
        &mut server,
        r#"<?php
function $0noReturn$0() { return 42; }
"#,
    )
    .await;
    assert!(
        t.iter().any(|s| s.to_lowercase().contains("return type")),
        "expected an Add return type action: {t:?}"
    );
}