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 color256_theme;
27pub mod color_policy;
28pub mod colors;
29pub mod diff;
30pub mod diff_paths;
31pub mod diff_preview;
32pub mod diff_theme;
33pub mod editor;
34pub mod env_lock;
35pub mod error_category;
36pub mod errors;
37pub mod exclusions;
38pub mod file_input;
39pub mod formatting;
40pub mod fs;
41pub mod http;
42pub mod image;
43pub mod interjection;
44pub mod interner;
45pub mod json_extract;
46pub mod llm;
47pub mod lr_map;
48pub mod memory;
49pub mod message_metadata;
50pub mod misconfiguration;
51pub mod modal_hints;
52pub mod model_family;
53pub mod paths;
54pub mod preview;
55pub mod project;
56pub mod provider;
57pub mod reasoning;
58pub mod reference;
59pub mod retry;
60pub mod runtime_diagnostics;
61pub mod sanitizer;
62pub mod search;
63pub mod serde_helpers;
64pub mod slug;
65#[doc(hidden)]
66pub mod startup_trace;
67pub mod stop_hints;
68pub mod styling;
69pub mod task_guard;
70pub mod telemetry;
71pub mod terminal_detection;
72pub mod text_fence;
73pub mod thread_safety;
74pub mod tokens;
75pub mod tool_types;
76pub mod trace_flush;
77pub mod ui_protocol;
78pub mod unicode;
79pub mod utils;
80pub mod validation;
81pub mod vtcode_paths;
82pub mod vtcodegitignore;
83pub mod walk;
84pub mod workspace_snapshot;
85pub use colors::{blend_colors, color_from_hex, contrasting_color, is_light_color, style};
86pub use editor::{
87    EditorPoint, EditorTarget, normalize_editor_hash_fragment, parse_editor_target, resolve_editor_path,
88    resolve_editor_target,
89};
90pub use error_category::{
91    BackoffStrategy, ErrorCategory, Retryability, classify_anyhow_error, classify_error_message,
92    is_context_capacity_error, is_context_capacity_message, is_retryable_llm_error_message,
93};
94pub use errors::{DisplayErrorFormatter, ErrorFormatter, ErrorReporter, MultiErrors, NoopErrorReporter};
95pub(crate) use interjection::{
96    EventQueue, FormattedInterjection, InterjectionBuffer, LARGE_PROMPT_THRESHOLD, PendingInterjection,
97    drain_formatted, format_interjection, user_query,
98};
99pub use interner::{StringId, StringInterner};
100pub use misconfiguration::{
101    ConfigGuidance, MisconfigurationKind, detect_misconfiguration, detect_misconfiguration_in_anyhow,
102    detect_misconfiguration_in_llm_error, is_misconfiguration,
103};
104pub use modal_hints::{
105    APPROVAL_NAVIGATE_CANCEL, APPROVAL_NAVIGATE_DENY, APPROVAL_NAVIGATE_STOP, choose_handling_line, truncate_modal_text,
106};
107pub use paths::{
108    PathExt, PathResolver, PathScope, StrPathExt, WorkspacePaths, canonicalize, canonicalize_async,
109    file_name_from_path, is_safe_relative_path, normalize_ascii_identifier, resolve_workspace_path,
110    workspace_relative_display,
111};
112pub use project::{ProjectOverview, build_project_overview};
113pub use reference::{MemoryErrorReporter, MemoryTelemetry, StaticWorkspacePaths};
114pub use stop_hints::{STOP_HINT_COMPACT, STOP_HINT_INLINE, with_stop_hint};
115pub use styling::{ColorPalette, DiffColorPalette, render_styled};
116pub use task_guard::TaskGuard;
117pub use telemetry::{NoopTelemetry, TelemetrySink};
118pub use tokens::{estimate_tokens, truncate_to_tokens};
119pub use unicode::{UNICODE_MONITOR, UnicodeMonitor, UnicodeValidationContext};
120pub use validation::{EmptyCollectionError, NonEmptySlice, NonEmptyString, NonEmptyVec};
121pub use vtcode_paths::{
122    MigrationEntry, MigrationFailure, MigrationReport, MigrationSkip, MigrationSkipReason, VtCodePaths,
123};
124
125// Re-export key thread safety primitives.
126pub(crate) use thread_safety::RelaxedAtomic;
vtcode_commons/lib.rs

vtcode_commons/
lib.rs
