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

//! Protocol-wired tests for hover over Laravel string-key calls (`env`,
//! `config`, `view`, `trans`/`__`, `route`, `asset`, `->middleware(...)`),
//! against a synthetic minimal Laravel project covering every domain.

use super::*;

use expect_test::expect;

fn write_full_laravel_project(root: &std::path::Path) {
    std::fs::write(root.join("artisan"), "#!/usr/bin/env php\n").unwrap();
    std::fs::write(root.join(".env"), "APP_NAME=Test\n").unwrap();
    std::fs::create_dir_all(root.join("config")).unwrap();
    std::fs::write(
        root.join("config").join("app.php"),
        "<?php\nreturn [\n    'name' => 'Laravel',\n];\n",
    )
    .unwrap();
    let views = root.join("resources").join("views");
    std::fs::create_dir_all(&views).unwrap();
    std::fs::write(views.join("welcome.blade.php"), "<h1>Welcome</h1>\n").unwrap();
    let en = root.join("lang").join("en");
    std::fs::create_dir_all(&en).unwrap();
    std::fs::write(
        en.join("auth.php"),
        "<?php\nreturn [\n    'failed' => 'These credentials do not match.',\n];\n",
    )
    .unwrap();
    std::fs::create_dir_all(root.join("routes")).unwrap();
    std::fs::write(
        root.join("routes").join("web.php"),
        "<?php\nRoute::get('/', HomeController::class)->name('home');\n",
    )
    .unwrap();
    std::fs::create_dir_all(root.join("public").join("css")).unwrap();
    std::fs::write(root.join("public").join("css").join("app.css"), "body {}\n").unwrap();
    std::fs::write(
        root.join("public").join("mix-manifest.json"),
        "{\n    \"/css/app.css\": \"/css/app.css?id=abc123\"\n}\n",
    )
    .unwrap();
    std::fs::create_dir_all(root.join("public").join("build")).unwrap();
    std::fs::write(
        root.join("public").join("build").join("manifest.json"),
        "{\n    \"resources/js/app.js\": {\"file\": \"assets/app-3f5d7f7a.js\"}\n}\n",
    )
    .unwrap();
    std::fs::create_dir_all(root.join("bootstrap")).unwrap();
    std::fs::write(
        root.join("bootstrap").join("app.php"),
        "<?php\nreturn Application::configure()\n    ->withMiddleware(function (Middleware $middleware) {\n        $middleware->alias([\n            'auth' => \\App\\Http\\Middleware\\Authenticate::class,\n        ]);\n    })->create();\n",
    )
    .unwrap();
}

#[tokio::test]
async fn env_call_hover_shows_dot_env_value() {
    let workspace = tempfile::tempdir().expect("workspace tempdir");
    write_full_laravel_project(workspace.path());
    let php = "<?php\n$name = env('APP_NAME');\n";
    std::fs::write(workspace.path().join("app.php"), php).unwrap();

    let mut s = TestServer::with_root(workspace.path()).await;
    s.wait_for_index_ready().await;
    s.open("app.php", php).await;

    // Line 1 (0-based), character 17 = inside "APP_NAME".
    let resp = s.hover("app.php", 1, 17).await;
    let out = render_hover(&resp);
    expect![[r#"
        **env('APP_NAME')**

        ```properties
        APP_NAME=Test
        ```

        `.env`"#]]
    .assert_eq(&out);
}

#[tokio::test]
async fn config_call_hover_shows_defining_line() {
    let workspace = tempfile::tempdir().expect("workspace tempdir");
    write_full_laravel_project(workspace.path());
    let php = "<?php\n$name = config('app.name');\n";
    std::fs::write(workspace.path().join("app.php"), php).unwrap();

    let mut s = TestServer::with_root(workspace.path()).await;
    s.wait_for_index_ready().await;
    s.open("app.php", php).await;

    // Line 1 (0-based), character 21 = inside "app.name".
    let resp = s.hover("app.php", 1, 21).await;
    let out = render_hover(&resp);
    expect![[r#"
        **config('app.name')**

        ```php
        'name' => 'Laravel',
        ```

        `config/app.php`"#]]
    .assert_eq(&out);
}

#[tokio::test]
async fn view_call_hover_shows_resolved_path_without_snippet() {
    let workspace = tempfile::tempdir().expect("workspace tempdir");
    write_full_laravel_project(workspace.path());
    let php = "<?php\nreturn view('welcome');\n";
    std::fs::write(workspace.path().join("app.php"), php).unwrap();

    let mut s = TestServer::with_root(workspace.path()).await;
    s.wait_for_index_ready().await;
    s.open("app.php", php).await;

    // Line 1 (0-based), character 16 = inside "welcome".
    let resp = s.hover("app.php", 1, 16).await;
    let out = render_hover(&resp);
    expect![[r#"
        **view('welcome')**

        `resources/views/welcome.blade.php`"#]]
    .assert_eq(&out);
}

#[tokio::test]
async fn trans_call_hover_shows_translation_value() {
    let workspace = tempfile::tempdir().expect("workspace tempdir");
    write_full_laravel_project(workspace.path());
    let php = "<?php\necho __('auth.failed');\n";
    std::fs::write(workspace.path().join("app.php"), php).unwrap();

    let mut s = TestServer::with_root(workspace.path()).await;
    s.wait_for_index_ready().await;
    s.open("app.php", php).await;

    // Line 1 (0-based), character 10 = inside "auth.failed".
    let resp = s.hover("app.php", 1, 10).await;
    let out = render_hover(&resp);
    expect![[r#"
        **trans('auth.failed')**

        ```php
        'failed' => 'These credentials do not match.',
        ```

        `lang/en/auth.php`"#]]
    .assert_eq(&out);
}

#[tokio::test]
async fn route_call_hover_shows_registration_line() {
    let workspace = tempfile::tempdir().expect("workspace tempdir");
    write_full_laravel_project(workspace.path());
    let php = "<?php\n$url = route('home');\n";
    std::fs::write(workspace.path().join("app.php"), php).unwrap();

    let mut s = TestServer::with_root(workspace.path()).await;
    s.wait_for_index_ready().await;
    s.open("app.php", php).await;

    // Line 1 (0-based), character 16 = inside "home".
    let resp = s.hover("app.php", 1, 16).await;
    let out = render_hover(&resp);
    expect![[r#"
        **route('home')**

        ```php
        Route::get('/', HomeController::class)->name('home');
        ```

        `routes/web.php`"#]]
    .assert_eq(&out);
}

#[tokio::test]
async fn asset_call_hover_shows_resolved_path_without_snippet() {
    let workspace = tempfile::tempdir().expect("workspace tempdir");
    write_full_laravel_project(workspace.path());
    let php = "<?php\n$href = asset('css/app.css');\n";
    std::fs::write(workspace.path().join("app.php"), php).unwrap();

    let mut s = TestServer::with_root(workspace.path()).await;
    s.wait_for_index_ready().await;
    s.open("app.php", php).await;

    // Line 1 (0-based), character 20 = inside "css/app.css".
    let resp = s.hover("app.php", 1, 20).await;
    let out = render_hover(&resp);
    expect![[r#"
        **asset('css/app.css')**

        `public/css/app.css`"#]]
    .assert_eq(&out);
}

#[tokio::test]
async fn mix_call_hover_shows_manifest_entry() {
    let workspace = tempfile::tempdir().expect("workspace tempdir");
    write_full_laravel_project(workspace.path());
    let php = "<?php\n$href = mix('css/app.css');\n";
    std::fs::write(workspace.path().join("app.php"), php).unwrap();

    let mut s = TestServer::with_root(workspace.path()).await;
    s.wait_for_index_ready().await;
    s.open("app.php", php).await;

    // Line 1 (0-based), character 18 = inside "css/app.css".
    let resp = s.hover("app.php", 1, 18).await;
    let out = render_hover(&resp);
    expect![[r#"
        **mix('css/app.css')**

        ```json
        "/css/app.css": "/css/app.css?id=abc123"
        ```

        `public/mix-manifest.json`"#]]
    .assert_eq(&out);
}

#[tokio::test]
async fn vite_call_hover_shows_manifest_entry() {
    let workspace = tempfile::tempdir().expect("workspace tempdir");
    write_full_laravel_project(workspace.path());
    let php = "<?php\n$tags = vite('resources/js/app.js');\n";
    std::fs::write(workspace.path().join("app.php"), php).unwrap();

    let mut s = TestServer::with_root(workspace.path()).await;
    s.wait_for_index_ready().await;
    s.open("app.php", php).await;

    // Line 1 (0-based), character 20 = inside "resources/js/app.js".
    let resp = s.hover("app.php", 1, 20).await;
    let out = render_hover(&resp);
    expect![[r#"
        **vite('resources/js/app.js')**

        ```json
        "resources/js/app.js": {"file": "assets/app-3f5d7f7a.js"}
        ```

        `public/build/manifest.json`"#]]
    .assert_eq(&out);
}

#[tokio::test]
async fn vite_asset_static_call_hover_shows_manifest_entry() {
    let workspace = tempfile::tempdir().expect("workspace tempdir");
    write_full_laravel_project(workspace.path());
    let php = "<?php\n$src = Vite::asset('resources/js/app.js');\n";
    std::fs::write(workspace.path().join("app.php"), php).unwrap();

    let mut s = TestServer::with_root(workspace.path()).await;
    s.wait_for_index_ready().await;
    s.open("app.php", php).await;

    // Line 1 (0-based), character 30 = inside "resources/js/app.js".
    let resp = s.hover("app.php", 1, 30).await;
    let out = render_hover(&resp);
    expect![[r#"
        **Vite::asset('resources/js/app.js')**

        ```json
        "resources/js/app.js": {"file": "assets/app-3f5d7f7a.js"}
        ```

        `public/build/manifest.json`"#]]
    .assert_eq(&out);
}

#[tokio::test]
async fn middleware_call_hover_shows_alias_registration() {
    let workspace = tempfile::tempdir().expect("workspace tempdir");
    write_full_laravel_project(workspace.path());
    let php = "<?php\nRoute::get('/', HomeController::class)->middleware('auth');\n";
    std::fs::write(workspace.path().join("app.php"), php).unwrap();

    let mut s = TestServer::with_root(workspace.path()).await;
    s.wait_for_index_ready().await;
    s.open("app.php", php).await;

    // Line 1 (0-based), character 54 = inside "auth".
    let resp = s.hover("app.php", 1, 54).await;
    let out = render_hover(&resp);
    expect![[r#"
        **middleware('auth')**

        ```php
        'auth' => \App\Http\Middleware\Authenticate::class,
        ```

        `bootstrap/app.php`"#]]
    .assert_eq(&out);
}

#[tokio::test]
async fn env_call_hover_none_outside_laravel_project() {
    let workspace = tempfile::tempdir().expect("workspace tempdir");
    // No `artisan` marker — plain PHP project.
    let php = "<?php\n$name = env('APP_NAME');\n";
    std::fs::write(workspace.path().join("app.php"), php).unwrap();
    std::fs::write(workspace.path().join(".env"), "APP_NAME=Test\n").unwrap();

    let mut s = TestServer::with_root(workspace.path()).await;
    s.wait_for_index_ready().await;
    s.open("app.php", php).await;

    let resp = s.hover("app.php", 1, 17).await;
    let out = render_hover(&resp);
    expect!["<no hover>"].assert_eq(&out);
}