projectdetect 0.1.0

Detect what kind of project a directory is (Go, Node, Rust, Xcode, …) by canonical indicator files, with recursive discovery, file→project resolution, and custom YAML/CEL types.
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

//! YAML config loading — ports `config_test.go`.

mod common;

use common::{touch, write};
use projectdetect::Registry;
use tempfile::tempdir;

fn detects(reg: &Registry, dir: &std::path::Path, want_type: &str) -> bool {
    reg.detect(dir).iter().any(|m| m.r#type == want_type)
}

/// Mixed `has_file` / `has_glob` indicators load and detect.
#[test]
fn mixed_indicators() {
    let tmp = tempdir().unwrap();
    write(
        tmp.path(),
        "types.yaml",
        r#"
project_types:
  - name: helm-chart
    indicators:
      - has_file: Chart.yaml
  - name: tf-stack
    indicators:
      - has_glob: "*.tf"
"#,
    );
    let mut reg = Registry::new();
    let n = reg.load_from_file(tmp.path().join("types.yaml")).unwrap();
    assert_eq!(n, 2);

    let chart = tempdir().unwrap();
    touch(chart.path(), "Chart.yaml");
    assert!(detects(&reg, chart.path(), "helm-chart"));

    let tf = tempdir().unwrap();
    touch(tf.path(), "main.tf");
    assert!(detects(&reg, tf.path(), "tf-stack"));
}

/// `has_subdir_glob` matches a subdirectory bundle but not a same-named file.
#[test]
fn subdir_glob_indicator() {
    let tmp = tempdir().unwrap();
    write(
        tmp.path(),
        "types.yaml",
        "project_types:\n  - name: xcode-app\n    indicators:\n      - has_subdir_glob: \"*.xcodeproj\"\n",
    );
    let mut reg = Registry::new();
    assert_eq!(
        reg.load_from_file(tmp.path().join("types.yaml")).unwrap(),
        1
    );

    let bundle = tempdir().unwrap();
    common::mkdir(bundle.path(), "MyApp.xcodeproj");
    assert!(detects(&reg, bundle.path(), "xcode-app"));

    let as_file = tempdir().unwrap();
    touch(as_file.path(), "MyApp.xcodeproj");
    assert!(!detects(&reg, as_file.path(), "xcode-app"));
}

/// An entry with no indicators is a load error.
#[test]
fn missing_indicators_errors() {
    let tmp = tempdir().unwrap();
    write(
        tmp.path(),
        "types.yaml",
        "project_types:\n  - name: missing\n",
    );
    let mut reg = Registry::new();
    assert!(reg.load_from_file(tmp.path().join("types.yaml")).is_err());
}

/// Without the `cel` feature, a `cel:` indicator fails to register.
#[cfg(not(feature = "cel"))]
#[test]
fn cel_disabled_errors() {
    let tmp = tempdir().unwrap();
    write(
        tmp.path(),
        "types.yaml",
        "project_types:\n  - name: c\n    indicators:\n      - cel: '\"x\" in files'\n",
    );
    let mut reg = Registry::new();
    assert!(reg.load_from_file(tmp.path().join("types.yaml")).is_err());
}

/// A CEL indicator with AND-semantics across `files` and `subdirs`.
#[cfg(feature = "cel")]
#[test]
fn cel_indicator_and_semantics() {
    let tmp = tempdir().unwrap();
    write(
        tmp.path(),
        "types.yaml",
        "project_types:\n  - name: my-app\n    indicators:\n      - cel: '\"services\" in subdirs && \"foo.yaml\" in files'\n",
    );
    let mut reg = Registry::new();
    assert_eq!(
        reg.load_from_file(tmp.path().join("types.yaml")).unwrap(),
        1
    );

    // Has both → matches.
    let yes = tempdir().unwrap();
    common::mkdir(yes.path(), "services");
    touch(yes.path(), "foo.yaml");
    assert!(detects(&reg, yes.path(), "my-app"));

    // Missing the `services` subdir → no match.
    let no = tempdir().unwrap();
    touch(no.path(), "foo.yaml");
    assert!(!detects(&reg, no.path(), "my-app"));
}

/// A malformed CEL expression is a compile error at load time.
#[cfg(feature = "cel")]
#[test]
fn bad_cel_errors() {
    let tmp = tempdir().unwrap();
    write(
        tmp.path(),
        "types.yaml",
        "project_types:\n  - name: broken\n    indicators:\n      - cel: 'this is not valid cel ((('\n",
    );
    let mut reg = Registry::new();
    assert!(reg.load_from_file(tmp.path().join("types.yaml")).is_err());
}