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

//! Laravel-project detection: gates every other module in `laravel/` behind a
//! cheap one-time check so non-Laravel workspaces pay no cost.

use std::path::Path;

/// True if `root` looks like the root of a Laravel application: either an
/// `artisan` CLI script (present in every Laravel skeleton) or a
/// `composer.json` that requires `laravel/framework`.
pub(super) fn is_laravel_project(root: &Path) -> bool {
    if root.join("artisan").is_file() {
        return true;
    }
    let Ok(text) = std::fs::read_to_string(root.join("composer.json")) else {
        return false;
    };
    let Ok(json) = serde_json::from_str::<serde_json::Value>(&text) else {
        return false;
    };
    json["require"]["laravel/framework"].is_string()
        || json["require-dev"]["laravel/framework"].is_string()
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn detects_via_artisan_file() {
        let tmp = tempfile::tempdir().unwrap();
        std::fs::write(tmp.path().join("artisan"), "#!/usr/bin/env php").unwrap();
        assert!(is_laravel_project(tmp.path()));
    }

    #[test]
    fn detects_via_composer_require() {
        let tmp = tempfile::tempdir().unwrap();
        std::fs::write(
            tmp.path().join("composer.json"),
            r#"{"require": {"laravel/framework": "^11.0"}}"#,
        )
        .unwrap();
        assert!(is_laravel_project(tmp.path()));
    }

    #[test]
    fn detects_via_composer_require_dev() {
        let tmp = tempfile::tempdir().unwrap();
        std::fs::write(
            tmp.path().join("composer.json"),
            r#"{"require-dev": {"laravel/framework": "^11.0"}}"#,
        )
        .unwrap();
        assert!(is_laravel_project(tmp.path()));
    }

    #[test]
    fn non_laravel_project_not_detected() {
        let tmp = tempfile::tempdir().unwrap();
        std::fs::write(
            tmp.path().join("composer.json"),
            r#"{"require": {"symfony/framework-bundle": "^7.0"}}"#,
        )
        .unwrap();
        assert!(!is_laravel_project(tmp.path()));
    }

    #[test]
    fn missing_composer_json_not_detected() {
        let tmp = tempfile::tempdir().unwrap();
        assert!(!is_laravel_project(tmp.path()));
    }

    #[test]
    fn malformed_composer_json_not_detected() {
        let tmp = tempfile::tempdir().unwrap();
        std::fs::write(tmp.path().join("composer.json"), "{not valid json").unwrap();
        assert!(!is_laravel_project(tmp.path()));
    }
}