gg-cli 0.41.0

GG - Gui for JJ
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
90
91
92
93
94
95
96

//! # GG: Gui for [JJ](https://jj-vcs.github.io/jj/)
//!
//! This crate exposes two ways to embed GG's functionality in your own application:
//!
//! ## Axum router (for embedding `gg web`)
//!
//! [`web::create_app`] returns an [`axum::Router`] that serves both the embedded
//! UI and a JSON API. This is the easiest integration path — you get a fully
//! working GG instance that can be composed with other Axum services or bound to
//! any [`tokio::net::TcpListener`].
//!
//! ## Worker session (for a custom embedding or use as an API)
//!
//! For lower-level control, create a [`worker::WorkerSession`] and drive it with
//! [`worker::SessionEvent`] messages over a standard [`std::sync::mpsc`] channel.
//! This is how both the Tauri GUI and the web server work internally — each
//! window/tab owns one worker thread because jj-lib is single-threaded.
//!
//! The worker thread is a state machine: [`worker::WorkerSession`] (unloaded) →
//! `WorkspaceSession` (loaded) → `QuerySession` (pagination). Only the first state
//! is public; transitions happen automatically in response to [`worker::SessionEvent`] messages.

pub mod askpass;
pub mod config;
pub mod messages;
pub mod web;
pub mod worker;

pub use config::read_config;
use jj_lib::settings::UserSettings;
use std::path::PathBuf;

/// Configuration passed to [`web::create_app`] or the internal GUI launcher.
///
/// Use [`RunOptions::new`] for a simple starting point, or [`read_context`]
/// and [`read_config`] to put the pieces together yourself.
pub struct RunOptions {
    /// Tauri context generated by [`tauri::generate_context!`]. Contains the
    /// embedded frontend assets that the web server serves as static files.
    pub context: tauri::Context<tauri::Wry>,

    /// Jujutsu user settings (as seen in `jj config`).
    pub settings: UserSettings,

    /// Working directory to open on startup. When `None`, the worker falls
    /// back to the process's current directory (or `$OWD` on AppImage).
    pub workspace: Option<PathBuf>,

    /// Skip immutability checks on commits. Intended for testing or
    /// scripted workflows where the revset-based immutable set is too
    /// restrictive.
    pub ignore_immutable: bool,

    /// Enable an askpass IPC server for git authentication prompts.
    /// When `false` (the default), the askpass socket/server is not started
    /// and git operations that need credentials will fail.
    /// Set to `true` if your main() calls [`askpass::run_askpass`] to
    /// act as an askpass client.
    pub enable_askpass: bool,

    /// Enable verbose logging (`LevelFilter::Debug` for the `gg` target).
    #[doc(hidden)]
    pub debug: bool,

    /// Indicates this process was spawned by another GG instance. When `true`,
    /// the web server prints `"Startup complete."` to stdout so the parent
    /// knows the port is ready.
    #[doc(hidden)]
    pub is_child: bool,
}

impl RunOptions {
    /// Creates a `RunOptions` pointing at the given workspace directory.
    ///
    /// Loads Jujutsu settings from the standard config locations and generates
    /// a Tauri context. All boolean flags default to `false`.
    pub fn new(workspace: PathBuf) -> Self {
        let repo_path = config::resolve_repo_path(Some(workspace.as_ref()));
        let (settings, _, _, _) = read_config(repo_path.as_deref()).unwrap();
        let context = read_context();
        RunOptions {
            context,
            settings,
            workspace: Some(workspace),
            debug: false,
            is_child: false,
            ignore_immutable: false,
            enable_askpass: false,
        }
    }
}

/// Load the context generated by [`tauri::generate_context!`], which contains the embedded frontend assets.
pub fn read_context() -> tauri::Context<tauri::Wry> {
    tauri::generate_context!()
}