pilegit 0.1.14

Git stacking with style — interactive TUI for stacked PRs
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

pub mod github;
pub mod gitlab;
pub mod gitea;
pub mod phabricator;
pub mod custom;

use std::collections::HashMap;

use color_eyre::Result;

use crate::core::config::Config;
use crate::core::stack::PatchEntry;
use crate::git::ops::Repo;

/// Trait for code review platform integrations.
pub trait Forge {
    /// Submit a new PR/MR/revision for a commit.
    fn submit(
        &self, repo: &Repo, hash: &str, subject: &str,
        base: &str, body: &str,
    ) -> Result<String>;

    /// Update an existing PR/MR/revision (force-push + update base).
    fn update(
        &self, repo: &Repo, hash: &str, subject: &str, base: &str,
    ) -> Result<String>;

    /// List open PRs/MRs for the user's pgit branches.
    /// Returns (branch_name → number, whether the CLI is available).
    fn list_open(&self, repo: &Repo) -> (HashMap<String, u32>, bool);

    /// Edit the base/target branch of a PR/MR.
    fn edit_base(&self, repo: &Repo, branch: &str, base: &str) -> bool;

    /// Mark submitted patches based on open reviews.
    fn mark_submitted(&self, repo: &Repo, patches: &mut [PatchEntry]);

    /// Sync all submitted reviews: force-push + update bases.
    fn sync(
        &self, repo: &Repo, patches: &[PatchEntry],
        on_progress: &dyn Fn(&str),
    ) -> Result<Vec<String>>;

    /// Whether pilegit should open an editor for the description before submit.
    /// Platforms like Phabricator have their own editor flow.
    fn needs_description_editor(&self) -> bool { true }

    /// Extract trailers from a commit body that should be preserved during squash.
    /// Each forge knows its own trailer format (e.g. "Differential Revision:" for
    /// Phabricator, "Change-Id:" for Gerrit). Default: none.
    fn get_trailers(&self, _body: &str) -> Vec<String> { Vec::new() }

    /// Find dependency trailers across all commits in the stack.
    /// Called after rebase or before sync when commit order may have changed.
    /// Default: no-op. Phabricator uses this to update "Depends on DXXX".
    fn fix_dependencies(&self, _repo: &Repo) -> Result<()> { Ok(()) }

    /// Detect forge-specific stale branches that aren't caught by ancestor checks.
    /// E.g. Phabricator's `arc land` squashes commits into a new hash but
    /// preserves the `Differential Revision:` trailer — this method matches
    /// branches by trailer against the base branch history.
    /// Default: no-op (returns empty).
    fn find_landed_branches(&self, _repo: &Repo, _branches: &[String]) -> Vec<String> {
        Vec::new()
    }

    /// Display name of the platform.
    fn name(&self) -> &str;
}

/// Create the appropriate Forge based on config.
pub fn create_forge(config: &Config) -> Box<dyn Forge> {
    match config.forge.forge_type.as_str() {
        "github" => Box::new(github::GitHub),
        "gitlab" => Box::new(gitlab::GitLab),
        "gitea" => Box::new(gitea::Gitea),
        "phabricator" => Box::new(phabricator::Phabricator),
        "custom" => Box::new(custom::Custom::new(
            config.forge.submit_cmd.clone().unwrap_or_default(),
        )),
        _ => Box::new(github::GitHub),
    }
}