vtcode_commons/
lib.rs

1#![allow(
2    missing_docs,
3    clippy::expect_used,
4    dead_code,
5    unused_imports,
6    reason = "Intentional compatibility, platform, or test-only suppression."
7)]
8//! Shared primitives and helper types reused across VT Code crates.
9//!
10//! This crate provides the foundational building blocks that both the core
11//! agent library (`vtcode-core`) and the terminal UI (`vtcode-ui`) depend on.
12//! Modules include ANSI processing, diff rendering, file traversal, color
13//! policy, error classification, and shared protocol types.
14//!
15//! Items live here (rather than `vtcode-ui`) when they are consumed by
16//! `vtcode-core` or the main binary -- keeping the dependency direction clean.
17//!
18//! See `docs/modules/vtcode_commons_reference.md` for ready-to-use adapters.
19
20pub mod ansi;
21pub mod ansi_capabilities;
22pub mod ansi_codes;
23pub mod async_utils;
24pub mod at_pattern;
25pub mod cgp;
26pub mod clipboard_5522;
27pub mod color256_theme;
28pub mod color_policy;
29pub mod colors;
30pub mod content_search;
31pub mod diff;
32pub mod diff_paths;
33pub mod diff_preview;
34pub mod diff_theme;
35pub mod editor;
36pub mod env_lock;
37pub mod error_category;
38pub mod errors;
39pub mod exclusions;
40pub mod file_input;
41pub mod formatting;
42pub mod fs;
43pub mod history_scope;
44pub mod http;
45pub mod image;
46pub mod interjection;
47pub mod interner;
48pub mod json_extract;
49pub mod lexical;
50pub mod line_framing;
51pub mod llm;
52pub mod lr_map;
53pub mod memory;
54pub mod message_metadata;
55pub mod message_timestamp;
56pub mod misconfiguration;
57pub mod modal_hints;
58pub mod model_family;
59pub mod paths;
60pub mod preview;
61pub mod program_status;
62pub mod project;
63pub mod prompt_history;
64pub mod provider;
65pub mod reasoning;
66pub mod reference;
67pub mod retry;
68pub mod runtime_diagnostics;
69pub mod sanitizer;
70pub mod search;
71pub mod serde_helpers;
72pub mod slug;
73#[doc(hidden)]
74pub mod startup_trace;
75pub mod stop_hints;
76pub mod styling;
77pub mod task_guard;
78pub mod telemetry;
79pub mod terminal_capabilities;
80pub mod terminal_detection;
81pub mod text_fence;
82pub mod thread_safety;
83pub mod tokens;
84pub mod tool_headlines;
85pub mod tool_intent;
86pub mod tool_types;
87pub mod trace_flush;
88pub mod tracker_title;
89pub mod tty;
90pub mod ui_protocol;
91pub mod unicode;
92pub mod utf8_stream;
93pub mod utils;
94pub mod validation;
95pub mod vtcode_paths;
96pub mod vtcodegitignore;
97pub mod walk;
98pub mod workspace_snapshot;
99pub use colors::{blend_colors, color_from_hex, contrasting_color, is_light_color, style};
100pub use editor::{
101    EditorPoint, EditorTarget, normalize_editor_hash_fragment, parse_editor_target, resolve_editor_path,
102    resolve_editor_target,
103};
104pub use error_category::{
105    BackoffStrategy, ErrorCategory, Retryability, classify_anyhow_error, classify_error_message,
106    is_context_capacity_error, is_context_capacity_message, is_retryable_llm_error_message,
107};
108pub use errors::{DisplayErrorFormatter, ErrorFormatter, ErrorReporter, MultiErrors, NoopErrorReporter};
109pub(crate) use interjection::{
110    EventQueue, FormattedInterjection, InterjectionBuffer, LARGE_PROMPT_THRESHOLD, PendingInterjection,
111    drain_formatted, format_interjection, user_query,
112};
113pub use interner::{StringId, StringInterner};
114pub use misconfiguration::{
115    ConfigGuidance, MisconfigurationKind, detect_misconfiguration, detect_misconfiguration_in_anyhow,
116    detect_misconfiguration_in_llm_error, is_misconfiguration,
117};
118pub use modal_hints::{
119    APPROVAL_NAVIGATE_CANCEL, APPROVAL_NAVIGATE_DENY, APPROVAL_NAVIGATE_STOP, choose_handling_line, truncate_modal_text,
120};
121pub use paths::{
122    PathExt, PathResolver, PathScope, StrPathExt, WorkspacePathDisplay, WorkspacePaths, canonicalize,
123    canonicalize_async, file_name_from_path, is_safe_relative_path, normalize_ascii_identifier, resolve_workspace_path,
124    safe_archive_relative_path, validate_no_escaping_symlink_ancestors, workspace_relative_display,
125    workspace_relative_slash,
126};
127pub use project::{ProjectOverview, build_project_overview};
128pub use reference::{MemoryErrorReporter, MemoryTelemetry, StaticWorkspacePaths};
129pub use stop_hints::{STOP_HINT_COMPACT, STOP_HINT_INLINE, with_stop_hint};
130pub use styling::{ColorPalette, DiffColorPalette, render_styled};
131pub use task_guard::TaskGuard;
132pub use telemetry::{NoopTelemetry, TelemetrySink};
133pub use tokens::{
134    CHARS_PER_TOKEN, estimate_tokens, format_token_count, heuristic_tokens_from_byte_len,
135    heuristic_tokens_from_byte_len_u64, truncate_to_tokens,
136};
137pub use unicode::{UNICODE_MONITOR, UnicodeMonitor, UnicodeValidationContext};
138pub use utf8_stream::Utf8StreamDecoder;
139pub use validation::{EmptyCollectionError, NonEmptySlice, NonEmptyString, NonEmptyVec};
140pub use vtcode_paths::{
141    MigrationEntry, MigrationFailure, MigrationReport, MigrationSkip, MigrationSkipReason, VtCodePaths,
142};
143
144// Re-export key thread safety primitives.
145pub(crate) use thread_safety::RelaxedAtomic;
146
147/// Canonical runtime diagnostic sanitization.
148pub mod diagnostics;
vtcode_commons/lib.rs

vtcode_commons/
lib.rs
