vscodehelper 0.2.0

Understanding the data that VSCode writes to disk
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

# VSCodeHelper


A Rust library for interacting with Visual Studio Code's configuration and state files.

## Overview


VSCodeHelper provides a convenient way to access and manipulate various VS Code configuration files, including:

- `storage.json` - Contains information about open windows, workspaces, themes, and more
- `state.vscdb` - SQLite database containing recently opened paths and other state information
- Workspace configuration files

## Features


- Load and parse VS Code's `storage.json` file
- Access recently opened folders and workspaces
- Query the `state.vscdb` SQLite database
- Retrieve workspace configurations
- Strong typing for VS Code's configuration structures

## Examples


### List Recently Opened Paths


```rust
use vscodehelper::state_vscdb::keys::history_recently_opened_paths_list::HistoryRecentlyOpenedPathsListKey;
use vscodehelper::state_vscdb::state_vscdb::StateVscdb;

fn main() -> eyre::Result<()> {
    let mut state_vscdb = StateVscdb::try_default()?;
    let recently_opened = state_vscdb.read::<HistoryRecentlyOpenedPathsListKey>()?;
    
    println!("Recently opened paths:");
    for entry in recently_opened.entries.iter() {
        println!("  - {:?}", entry);
    }

    Ok(())
}
```

### Get Currently Opened Windows


```rust
use vscodehelper::storage_json::storage_json::VSCodeStorageJson;
use vscodehelper::storage_json::window::Window;

fn main() -> eyre::Result<()> {
    let storage_json = VSCodeStorageJson::load_from_disk()?;
    
    for window in &storage_json.windows_state.opened_windows {
        match window {
            Window::FolderWindow { folder, .. } => {
                println!("{}", folder.as_path()?.display());
            }
            Window::WorkspaceWindow { workspace_identifier, .. } => {
                let workspace_json = workspace_identifier.read()?;
                for folder in workspace_json.folders {
                    println!("{}", folder.path.display());
                }
            }
        }
    }
    
    Ok(())
}
```

### Get Current Theme


```rust
use vscodehelper::storage_json::storage_json::VSCodeStorageJson;

fn main() -> eyre::Result<()> {
    let storage_json = VSCodeStorageJson::load_from_disk()?;
    println!("The active theme is {}", storage_json.theme);
    Ok(())
}
```

## Project Structure


- `src/storage_json/` - Types and functions for working with VS Code's storage.json
- `src/state_vscdb/` - Types and functions for working with VS Code's state.vscdb
- `src/workspace_json/` - Types for working with VS Code workspace files
- `vscodehelper-macros/` - Procedural macros for generating common trait implementations

## Installation


```pwsh
cargo add vscodehelper
```

## Requirements


- Rust 2024 Edition
- VS Code installed on your system
- Probably only works on Windows lol