projd-core 0.6.1

Core project scanning data model and analysis helpers for Projd.
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

use std::fs;
use std::path::Path;

use projd_core::{IdentitySource, ProjectKind, render_markdown, scan_path};
use tempfile::TempDir;

#[test]
fn detects_rust_package_identity_from_cargo_manifest() {
    let fixture = ProjectFixture::new();
    fixture.write(
        "Cargo.toml",
        "[package]\nname = \"demo-rust\"\nversion = \"1.2.3\"\nedition = \"2024\"\n",
    );

    let scan = scan_path(fixture.path()).expect("scan succeeds");

    assert_eq!(scan.identity.name, "demo-rust");
    assert_eq!(scan.identity.version.as_deref(), Some("1.2.3"));
    assert_eq!(scan.identity.kind, ProjectKind::RustPackage);
    assert_eq!(scan.identity.source, IdentitySource::CargoToml);
}

#[test]
fn detects_rust_workspace_identity_from_workspace_manifest() {
    let fixture = ProjectFixture::new();
    fixture.write(
        "Cargo.toml",
        "[workspace]\nmembers = [\"crates/demo\"]\n[workspace.package]\nversion = \"0.4.0\"\n",
    );

    let scan = scan_path(fixture.path()).expect("scan succeeds");

    assert_eq!(scan.identity.name, fixture.name());
    assert_eq!(scan.identity.version.as_deref(), Some("0.4.0"));
    assert_eq!(scan.identity.kind, ProjectKind::RustWorkspace);
    assert_eq!(scan.identity.source, IdentitySource::CargoToml);
}

#[test]
fn detects_node_package_identity_from_package_json() {
    let fixture = ProjectFixture::new();
    fixture.write(
        "package.json",
        "{\"name\":\"demo-node\",\"version\":\"2.0.1\"}\n",
    );

    let scan = scan_path(fixture.path()).expect("scan succeeds");

    assert_eq!(scan.identity.name, "demo-node");
    assert_eq!(scan.identity.version.as_deref(), Some("2.0.1"));
    assert_eq!(scan.identity.kind, ProjectKind::NodePackage);
    assert_eq!(scan.identity.source, IdentitySource::PackageJson);
}

#[test]
fn detects_python_project_identity_from_pyproject_toml() {
    let fixture = ProjectFixture::new();
    fixture.write(
        "pyproject.toml",
        "[project]\nname = \"demo-python\"\nversion = \"3.1.4\"\n",
    );

    let scan = scan_path(fixture.path()).expect("scan succeeds");

    assert_eq!(scan.identity.name, "demo-python");
    assert_eq!(scan.identity.version.as_deref(), Some("3.1.4"));
    assert_eq!(scan.identity.kind, ProjectKind::PythonProject);
    assert_eq!(scan.identity.source, IdentitySource::PyprojectToml);
}

#[test]
fn falls_back_to_directory_identity() {
    let fixture = ProjectFixture::new();
    fixture.write("README.md", "# Generic\n");

    let scan = scan_path(fixture.path()).expect("scan succeeds");

    assert_eq!(scan.identity.name, fixture.name());
    assert_eq!(scan.identity.version, None);
    assert_eq!(scan.identity.kind, ProjectKind::Generic);
    assert_eq!(scan.identity.source, IdentitySource::DirectoryName);
}

#[test]
fn renders_identity_in_markdown_report() {
    let fixture = ProjectFixture::new();
    fixture.write(
        "Cargo.toml",
        "[package]\nname = \"demo-rust\"\nversion = \"1.2.3\"\nedition = \"2024\"\n",
    );

    let scan = scan_path(fixture.path()).expect("scan succeeds");
    let report = render_markdown(&scan);

    assert!(report.contains("## Identity"));
    assert!(report.contains("- Name: `demo-rust`"));
    assert!(report.contains("- Version: `1.2.3`"));
    assert!(report.contains("- Kind: RustPackage"));
    assert!(report.contains("- Source: CargoToml"));
}

struct ProjectFixture {
    temp_dir: TempDir,
}

impl ProjectFixture {
    fn new() -> Self {
        Self {
            temp_dir: tempfile::tempdir().expect("create temp dir"),
        }
    }

    fn path(&self) -> &Path {
        self.temp_dir.path()
    }

    fn name(&self) -> String {
        self.path()
            .file_name()
            .and_then(|value| value.to_str())
            .expect("temp dir has name")
            .to_owned()
    }

    fn write(&self, relative: &str, content: &str) {
        let path = self.path().join(relative);
        if let Some(parent) = path.parent() {
            fs::create_dir_all(parent).expect("create fixture parent");
        }
        fs::write(path, content).expect("write fixture file");
    }
}