php-lsp 0.4.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

//! Hover against symfony/demo. Run with `cargo test --release -- --ignored`.

mod common;

use common::TestServer;

fn hover_text(resp: &serde_json::Value) -> String {
    let c = &resp["result"]["contents"];
    if let Some(s) = c["value"].as_str() {
        return s.to_string();
    }
    if let Some(s) = c.as_str() {
        return s.to_string();
    }
    if let Some(arr) = c.as_array() {
        return arr
            .iter()
            .filter_map(|v| v["value"].as_str().or_else(|| v.as_str()))
            .collect::<Vec<_>>()
            .join("\n");
    }
    String::new()
}

#[tokio::test]
#[ignore = "php-lsp gap: hover on class identifier in `extends` clause returns null (inline-fixture hover works on function names only)"]
async fn hover_on_class_in_extends_clause() {
    let mut server = TestServer::with_fixture("symfony-demo").await;
    server.wait_for_index_ready().await;

    let path = "src/Controller/BlogController.php";
    let (text, line, character) = server.locate(path, "AbstractController", 1);
    server.open(path, &text).await;

    let resp = server.hover(path, line, character).await;
    assert!(resp["error"].is_null(), "hover error: {:?}", resp);
    assert!(
        !resp["result"].is_null(),
        "expected hover result on AbstractController"
    );
    let t = hover_text(&resp);
    assert!(
        t.contains("AbstractController"),
        "hover should mention AbstractController; got: {t}"
    );
}

#[tokio::test]
#[ignore = "php-lsp gap: hover on class name used as a parameter type returns null"]
async fn hover_on_app_entity_type_in_signature() {
    let mut server = TestServer::with_fixture("symfony-demo").await;
    server.wait_for_index_ready().await;

    let path = "src/Controller/BlogController.php";
    let (text, line, character) = server.locate(path, "Post $post", 0);
    server.open(path, &text).await;

    let resp = server.hover(path, line, character).await;
    assert!(resp["error"].is_null(), "hover error: {:?}", resp);
    assert!(
        !resp["result"].is_null(),
        "expected a hover result on Post entity"
    );
    let t = hover_text(&resp);
    assert!(
        t.contains("Post") && (t.contains("class") || t.contains("App\\Entity")),
        "hover on Post should surface class info; got: {t}"
    );
}