vtcode-commons 0.174.0

Shared traits for paths, telemetry, and error reporting reused across VT Code component extractions
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

# vtcode-commons

Shared traits for paths, telemetry, and error reporting reused across VT Code component extractions.

Keeps thin downstream crates like `vtcode-core` decoupled from VT Code's internal configuration and telemetry wiring
while sharing common contracts.

<!-- cargo-rdme start -->

Shared primitives and helper types reused across VT Code crates.

This crate provides the foundational building blocks that both the core agent library (`vtcode-core`) and the terminal
UI (`vtcode-ui`) depend on. Modules include ANSI processing, diff rendering, file traversal, color policy, error
classification, and shared protocol types.

Items live here (rather than `vtcode-ui`) when they are consumed by `vtcode-core` or the main binary -- keeping the
dependency direction clean.

See `docs/modules/vtcode_commons_reference.md` for ready-to-use adapters.

<!-- cargo-rdme end -->

## Modules

| Module                                             | Purpose                                                            |
| -------------------------------------------------- | ------------------------------------------------------------------ |
| `ansi`, `ansi_capabilities`, `ansi_codes`          | ANSI escape helpers and terminal capability detection              |
| `async_utils`                                      | Async convenience wrappers                                         |
| `colors`, `color_policy`, `color256_theme`         | Color utilities and theming                                        |
| `diff`, `diff_paths`, `diff_preview`, `diff_theme` | Unified diff rendering                                             |
| `errors`, `error_category`                         | Error formatting, reporting, and retry classification              |
| `formatting`                                       | Text formatting helpers                                            |
| `fs`                                               | Filesystem utilities                                               |
| `http`                                             | HTTP client helpers                                                |
| `image`                                            | Image processing utilities                                         |
| `llm`                                              | Core LLM types (`BackendKind`, `LLMError`, `LLMResponse`, `Usage`) |
| `paths`                                            | Path resolution traits and helpers                                 |
| `sanitizer`                                        | Input sanitization                                                 |
| `serde_helpers`                                    | Custom serde (de)serializers                                       |
| `telemetry`                                        | Telemetry sink trait                                               |
| `tokens`                                           | Token estimation and truncation                                    |
| `unicode`                                          | Unicode width monitoring                                           |
| `styling`, `preview`, `ui_protocol`                | Rendering and UI protocol types                                    |

## Public entrypoints

### Traits

- `ErrorFormatter` / `ErrorReporter` – format and report errors
- `PathResolver` / `PathScope` / `WorkspacePaths` – workspace-aware path resolution
- `TelemetrySink` – telemetry event sink

### Reference implementations

- `DisplayErrorFormatter`, `NoopErrorReporter`, `MemoryErrorReporter`
- `NoopTelemetry`, `MemoryTelemetry`
- `StaticWorkspacePaths`

### LLM types

- `BackendKind` – provider enum (OpenAI, Anthropic, Gemini, …)
- `Usage` – token usage tracking

### Error classification

- `ErrorCategory`, `BackoffStrategy`, `Retryability`

## Usage

```rust
use vtcode_commons::{PathResolver, ErrorReporter, TelemetrySink};

// Implement the traits for your application, or use the reference
// implementations for testing:
use vtcode_commons::{StaticWorkspacePaths, NoopTelemetry, NoopErrorReporter};
```

## Related docs

- [`docs/modules/vtcode_commons_reference.md`](../docs/modules/vtcode_commons_reference.md)

## API reference

<https://docs.rs/vtcode-commons>