vtcode_core/utils/
mod.rs

1//! # Utility Functions and Helpers
2//!
3//! This module provides various utility functions and helpers used throughout VT Code,
4//! including configuration management, path utilities, and common operations.
5//!
6//! ## Modules Overview
7//!
8//! ### Configuration Management (`dot_config`)
9//! - **User Preferences**: Theme settings, UI preferences, cache configuration
10//! - **Provider Configuration**: LLM provider settings and API keys
11//! - **Dotfile Management**: `.vtcode` directory and configuration files
12//!
13//! ### ANSI and Colors (`ansi`, `colors`)
14//! - **Terminal Colors**: ANSI color codes and styling
15//! - **Color Management**: Theme support and color schemes
16//! - **Cross-platform**: Works on different terminal types
17//!
18//! ### Git Integration (`vtcodegitignore`)
19//! - **Gitignore Management**: Automatic `.vtcodegitignore` creation
20//! - **Pattern Matching**: File exclusion patterns
21//! - **Workspace Safety**: Prevents accidental file operations
22//!
23//! ### Path Utilities (`path`)
24//! - **Path Normalization**: Resolve `.` and `..` components
25//! - **Shared Utilities**: Common path operations
26//!
27//! ## Basic Usage Examples
28//!
29//! ### Configuration Management
30//! ```rust,ignore
31//! use vtcode_core::utils::dot_config::{load_user_config, save_user_config, UserPreferences};
32//!
33//! #[tokio::main]
34//! async fn main() -> Result<(), Box<dyn std::error::Error>> {
35//!     // Load user configuration
36//!     let config = load_user_config().await?;
37//!
38//!     // Modify preferences
39//!     let mut prefs = config.preferences;
40//!     prefs.theme = "dark".to_string();
41//!
42//!     // Save changes
43//!     save_user_config(&prefs).await?;
44//!
45//!     Ok(())
46//! }
47//! ```
48//!
49//! ### ANSI Colors
50//! ```rust,ignore
51//! use vtcode_core::utils::ansi::{colorize, Color};
52//!
53//! let message = "Hello, World!";
54//! let colored = colorize(message, Color::Green);
55//! println!("{}", colored); // Prints green text
56//!
57//! // Or use styling functions
58//! let bold_text = vtcode_core::utils::ansi::bold("Important message");
59//! let red_error = colorize("Error occurred", Color::Red);
60//! ```
61//!
62//! ### Git Integration
63//! ```rust,ignore
64//! use vtcode_core::utils::vtcodegitignore::initialize_vtcode_gitignore;
65//!
66//! #[tokio::main]
67//! async fn main() -> Result<(), Box<dyn std::error::Error>> {
68//!     let workspace = std::env::current_dir()?;
69//!
70//!     // Initialize .vtcodegitignore
71//!     initialize_vtcode_gitignore(&workspace).await?;
72//!
73//!     println!("Git integration initialized");
74//!     Ok(())
75//! }
76//! ```
77
78pub mod ansi;
79pub mod ansi_capabilities;
80pub mod ansi_codes;
81pub mod ansi_parser;
82pub mod async_line_writer;
83pub mod async_utils;
84pub mod at_pattern;
85pub mod cached_style_parser;
86pub mod colors;
87pub mod common;
88pub mod diff;
89pub mod diff_styles;
90pub mod dot_config;
91pub mod error_log_collector;
92pub mod error_messages;
93pub mod file_input;
94pub mod file_utils;
95pub mod file_workflow;
96pub mod formatting;
97pub mod gatekeeper;
98pub mod http_client;
99pub mod image_processing;
100pub mod message_style;
101pub mod migration;
102pub mod path;
103pub mod serde_helpers;
104pub mod session_archive;
105pub mod session_debug;
106pub mod session_transcript_norm;
107pub mod style_helpers;
108pub mod terminal_color_probe;
109pub mod tokens;
110pub mod tool_name_parsing;
111pub mod trace_writer;
112pub mod transcript;
113pub mod tty;
114pub mod unicode_monitor;
115pub mod validation;
116pub mod vtcodegitignore;
117
118pub use cached_style_parser::CachedStyleParser;
119pub use common::{ProjectOverview, build_project_overview, current_timestamp, merge_env_patterns};
120pub use style_helpers::*;
vtcode_core/utils/mod.rs

vtcode_core/utils/
mod.rs
