shortcuts_tui/

lib.rs

//! Shortcuts TUI Library
//!
//! A comprehensive library for creating terminal user interfaces that display and manage
//! tools and shortcuts from configuration files.
//!
//! # Features
//!
//! - **Multiple Configuration Formats**: Support for both TOML and JSON configuration files
//! - **Rich TUI Interface**: Built with ratatui for a modern terminal experience
//! - **Flexible Organization**: Tools can be organized by categories and tagged for easy searching
//! - **Command Execution**: Execute tool commands directly from the interface
//! - **Search Functionality**: Powerful search across tool names, descriptions, and metadata
//! - **Validation**: Built-in configuration validation and error reporting
//! - **Extensible**: Modular design allows for easy extension and customization
//!
//! # Quick Start
//!
//! ```rust,no_run
//! use shortcuts_tui::{
//!     config::{Config, Tool, loader::ConfigLoader},
//!     ui::TuiApp,
//! };
//!
//! # fn main() -> shortcuts_tui::error::Result<()> {
//! // Load configuration from file
//! let loader = ConfigLoader::new();
//! let config = loader.load_file("shortcuts.toml")?;
//!
//! // Create and run the TUI application
//! let app = TuiApp::new(config)?;
//! app.run()?;
//! # Ok(())
//! # }
//! ```
//!
//! # Configuration Example
//!
//! ## TOML Format
//!
//! ```toml
//! [metadata]
//! title = "My Development Tools"
//! description = "A collection of useful development tools"
//! version = "1.0"
//! author = "Developer"
//!
//! [[categories]]
//! id = "dev"
//! name = "Development"
//! description = "Software development tools"
//! icon = "💻"
//! color = "blue"
//!
//! [[tools]]
//! id = "git_status"
//! name = "Git Status"
//! description = "Check git repository status"
//! command = "git status"
//! shortcut = "Ctrl+G S"
//! category = "dev"
//! tags = ["git", "vcs"]
//! priority = 10
//! enabled = true
//!
//! [tools.metadata]
//! documentation = "https://git-scm.com/docs/git-status"
//! ```
//!
//! ## JSON Format
//!
//! ```json
//! {
//!   "metadata": {
//!     "title": "My Development Tools",
//!     "description": "A collection of useful development tools",
//!     "version": "1.0",
//!     "author": "Developer"
//!   },
//!   "categories": [
//!     {
//!       "id": "dev",
//!       "name": "Development",
//!       "description": "Software development tools",
//!       "icon": "💻",
//!       "color": "blue"
//!     }
//!   ],
//!   "tools": [
//!     {
//!       "id": "git_status",
//!       "name": "Git Status",
//!       "description": "Check git repository status",
//!       "command": "git status",
//!       "shortcut": "Ctrl+G S",
//!       "category": "dev",
//!       "tags": ["git", "vcs"],
//!       "priority": 10,
//!       "enabled": true,
//!       "metadata": {
//!         "documentation": "https://git-scm.com/docs/git-status"
//!       }
//!     }
//!   ]
//! }
//! ```
//!
//! # Architecture
//!
//! The library is organized into several key modules:
//!
//! - [`config`]: Configuration loading, parsing, and validation
//! - [`ui`]: Terminal user interface components and application logic
//! - [`error`]: Comprehensive error handling and reporting
//!
//! ## Configuration System
//!
//! The configuration system supports:
//! - Multiple file formats (TOML, JSON)
//! - Automatic format detection
//! - Schema validation
//! - Default value handling
//! - Search path resolution
//!
//! ## User Interface
//!
//! The TUI provides:
//! - Multiple view modes (tools, categories, search, help)
//! - Keyboard navigation and shortcuts
//! - Real-time search and filtering
//! - Tool execution capabilities
//! - Responsive layout design
//!
//! ## Error Handling
//!
//! Comprehensive error handling with:
//! - Structured error types
//! - Context preservation
//! - User-friendly error messages
//! - Graceful degradation

pub mod config;
pub mod error;
pub mod ui;

// Re-export commonly used types for convenience
pub use config::{Config, Tool, Category, ConfigFormat};
pub use error::{Result, ShortcutsError, ConfigError, UiError};

/// Library version information
pub const VERSION: &str = env!("CARGO_PKG_VERSION");

/// Library name
pub const NAME: &str = env!("CARGO_PKG_NAME");

/// Library description
pub const DESCRIPTION: &str = env!("CARGO_PKG_DESCRIPTION");

/// Get library version information
pub fn version() -> &'static str {
    VERSION
}

/// Get library name
pub fn name() -> &'static str {
    NAME
}

/// Get library description
pub fn description() -> &'static str {
    DESCRIPTION
}

/// Create a sample configuration for demonstration purposes
///
/// # Returns
///
/// A [`Config`] instance populated with sample tools and categories
/// that demonstrate the various features of the configuration system.
///
/// # Example
///
/// ```rust
/// use shortcuts_tui::sample_config;
///
/// let config = sample_config();
/// assert!(!config.tools.is_empty());
/// assert!(!config.categories.is_empty());
/// ```
pub fn sample_config() -> Config {
    config::loader::create_sample_config()
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_version_info() {
        assert!(!version().is_empty());
        assert!(!name().is_empty());
        assert!(!description().is_empty());
    }

    #[test]
    fn test_sample_config() {
        let config = sample_config();
        assert!(!config.tools.is_empty());
        assert!(!config.categories.is_empty());
        
        // Validate the sample config
        assert!(config.validate().is_ok());
    }

    #[test]
    fn test_constants() {
        assert_eq!(VERSION, env!("CARGO_PKG_VERSION"));
        assert_eq!(NAME, env!("CARGO_PKG_NAME"));
        assert_eq!(DESCRIPTION, env!("CARGO_PKG_DESCRIPTION"));
    }
}