obsidian-cli-inspector 0.2.2

Local-first CLI/TUI for indexing and querying Obsidian vaults
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

use anyhow::Result;
use obsidian_cli_inspector::scanner::VaultScanner;
use std::fs;
use tempfile::TempDir;

#[test]
fn test_scanner_basic() -> Result<()> {
    let temp_dir = TempDir::new()?;
    let vault_path = temp_dir.path();

    // Create some markdown files
    fs::write(vault_path.join("note1.md"), "# Note 1")?;
    fs::write(vault_path.join("note2.md"), "# Note 2")?;

    let scanner = VaultScanner::new(vault_path.to_path_buf(), vec![]);
    let entries = scanner.scan()?;

    assert_eq!(entries.len(), 2);
    Ok(())
}

#[test]
fn test_scanner_excludes_patterns() -> Result<()> {
    let temp_dir = TempDir::new()?;
    let vault_path = temp_dir.path();

    // Create directories
    fs::create_dir_all(vault_path.join(".obsidian"))?;

    // Create files
    fs::write(vault_path.join("note.md"), "# Note")?;
    fs::write(vault_path.join(".obsidian/config.md"), "# Config")?;

    let scanner = VaultScanner::new(vault_path.to_path_buf(), vec![".obsidian/".to_string()]);
    let entries = scanner.scan()?;

    assert_eq!(entries.len(), 1);
    assert!(entries[0].relative_path.contains("note.md"));
    Ok(())
}

#[test]
fn test_scanner_nested_directories() -> Result<()> {
    let temp_dir = TempDir::new()?;
    let vault_path = temp_dir.path();

    fs::create_dir_all(vault_path.join("folder/subfolder"))?;
    fs::write(vault_path.join("root.md"), "# Root")?;
    fs::write(vault_path.join("folder/mid.md"), "# Mid")?;
    fs::write(vault_path.join("folder/subfolder/deep.md"), "# Deep")?;

    let scanner = VaultScanner::new(vault_path.to_path_buf(), vec![]);
    let entries = scanner.scan()?;

    assert_eq!(entries.len(), 3);
    Ok(())
}

#[test]
fn test_scanner_ignores_non_markdown() -> Result<()> {
    let temp_dir = TempDir::new()?;
    let vault_path = temp_dir.path();

    fs::write(vault_path.join("note.md"), "# Note")?;
    fs::write(vault_path.join("image.png"), "fake image")?;
    fs::write(vault_path.join("document.txt"), "text")?;

    let scanner = VaultScanner::new(vault_path.to_path_buf(), vec![]);
    let entries = scanner.scan()?;

    assert_eq!(entries.len(), 1);
    Ok(())
}

#[test]
fn test_scanner_file_metadata() -> Result<()> {
    let temp_dir = TempDir::new()?;
    let vault_path = temp_dir.path();

    let content = "# Test Note\n\nSome content here";
    fs::write(vault_path.join("note.md"), content)?;

    let scanner = VaultScanner::new(vault_path.to_path_buf(), vec![]);
    let entries = scanner.scan()?;

    assert_eq!(entries.len(), 1);
    assert!(entries[0].mtime > 0);
    assert_eq!(entries[0].size, content.len() as u64);
    Ok(())
}

#[test]
fn test_scanner_empty_vault() -> Result<()> {
    let temp_dir = TempDir::new()?;
    let vault_path = temp_dir.path();

    let scanner = VaultScanner::new(vault_path.to_path_buf(), vec![]);
    let entries = scanner.scan()?;

    assert_eq!(entries.len(), 0);
    Ok(())
}

#[test]
fn test_scanner_multiple_exclude_patterns() -> Result<()> {
    let temp_dir = TempDir::new()?;
    let vault_path = temp_dir.path();

    fs::create_dir_all(vault_path.join(".obsidian"))?;
    fs::create_dir_all(vault_path.join(".git"))?;

    fs::write(vault_path.join("note.md"), "# Note")?;
    fs::write(vault_path.join(".obsidian/config.md"), "# Config")?;
    fs::write(vault_path.join(".git/log.md"), "# Log")?;

    let scanner = VaultScanner::new(
        vault_path.to_path_buf(),
        vec![".obsidian/".to_string(), ".git/".to_string()],
    );
    let entries = scanner.scan()?;

    assert_eq!(entries.len(), 1);
    Ok(())
}

#[test]
fn test_scanner_paths_info() -> Result<()> {
    let temp_dir = TempDir::new()?;
    let vault_path = temp_dir.path();
    fs::create_dir_all(vault_path.join("dir"))?;
    fs::write(vault_path.join("dir/test.md"), "content")?;
    let scanner = VaultScanner::new(vault_path.to_path_buf(), vec![]);
    let entries = scanner.scan()?;
    assert_eq!(entries.len(), 1);
    assert!(entries[0].path.ends_with("test.md"));
    Ok(())
}