beads_rust 0.2.19

Agent-first issue tracker (SQLite + JSONL)
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
85
86
87
88
89

//! `beads_rust` - Agent-first issue tracker library
//!
//! This crate provides the core functionality for the `br` CLI tool,
//! a Rust port of the classic beads issue tracker.
//!
//! # Architecture
//!
//! The crate is organized into the following modules:
//!
//! - [`cli`] - Command-line interface using clap
//! - [`model`] - Data types (Issue, Dependency, Comment, Event)
//! - [`storage`] - `SQLite` database layer
//! - [`sync`] - JSONL import/export operations
//! - [`config`] - Configuration management
//! - [`cache`] - Pure cache policies for high-RAM acceleration
//! - [`coordination`] - Pure swarm coordination evidence contracts
//! - [`error`] - Error types and handling
//! - [`format`] - Output formatting (text, JSON)
//! - [`util`] - Utility functions (hashing, time, paths)
//! - [`write_combining`] - Compatibility contracts for future write combining

#![forbid(unsafe_code)]
// Lint configuration is in Cargo.toml [lints.clippy] section
#![allow(clippy::module_name_repetitions)]

pub mod cache;
pub mod cli;
pub mod close_policy;
pub mod config;
pub mod coordination;
pub mod error;
pub mod format;
pub mod health;
pub mod inheritance;
pub mod logging;
pub mod model;
pub mod output;
pub mod policy;
pub mod shutdown;
pub mod storage;
pub mod sync;
pub mod util;
pub mod validation;
pub mod write_combining;

#[cfg(feature = "mcp")]
pub mod mcp;

pub use error::{BeadsError, ErrorCode, Result, StructuredError};

/// Run the CLI application.
///
/// This is the main entry point called from `main()`.
///
/// # Errors
///
/// Returns an error if command execution fails.
#[allow(clippy::missing_const_for_fn)] // Will have side effects once implemented
pub fn run() -> Result<()> {
    // CLI execution is currently handled in main.rs directly.
    // This function can be used for library-level integration tests or embedding.
    Ok(())
}

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

    #[test]
    fn run_returns_ok() {
        assert!(run().is_ok());
    }

    #[test]
    fn structured_error_exit_code_matches_issue_errors() {
        let err = BeadsError::IssueNotFound {
            id: "bd-xyz".to_string(),
        };
        let structured = StructuredError::from_error(&err);
        assert_eq!(structured.code, ErrorCode::IssueNotFound);
        assert_eq!(structured.code.exit_code(), 3);
    }

    #[cfg(feature = "self_update")]
    #[test]
    fn upgrade_module_is_available_when_feature_enabled() {
        let _ = crate::cli::commands::upgrade::execute;
    }
}