gitflow_gitcode/lib.rs
1//! `gitflow-gitcode` —— GitCode 平台实现。
2//!
3//! 本 crate 实现了 `gitflow-core` 中定义的 [`IssueProvider`]、[`PrProvider`]、
4//! [`ReleaseProvider`]、[`ReviewProvider`]、[`AuthProvider`]、[`LabelProvider`]、
5//! [`MilestoneProvider`]、[`CommitProvider`] 与 [`PipelineProvider`] trait,
6//! 通过调用 `gc` CLI 获取数据并解析其 JSON 输出。
7//!
8//! # 主要类型
9//!
10//! - [`GitCodeIssueProvider`]:操作 GitCode Issue。
11//! - [`GitCodePrProvider`]:操作 GitCode Pull Request。
12//! - [`GitCodeReleaseProvider`]:操作 GitCode Release。
13//! - [`GitCodeReviewProvider`]:操作 GitCode PR Review。
14//! - [`GitCodeAuthProvider`]:处理 GitCode 认证(登录、登出、状态、Token)。
15//! - [`GitCodeLabelProvider`]:管理 GitCode 仓库标签。
16//! - [`GitCodeMilestoneProvider`]:管理 GitCode 仓库里程碑。
17//! - [`GitCodeCommitProvider`]:查看 GitCode Commit 及 Diff/Patch。
18//! - [`GitCodePipelineProvider`]:查看 GitCode CI/CD 流水线。
19//!
20//! # 错误处理
21//!
22//! 所有平台调用失败时,`gc` 的 stderr 会通过 [`error::parse_gitcode_error`] 解析,
23//! 并统一映射为 [`CoreError::Platform`]。
24//!
25//! [`IssueProvider`]: gitflow_core::issue::IssueProvider
26//! [`PrProvider`]: gitflow_core::pr::PrProvider
27//! [`ReleaseProvider`]: gitflow_core::release::ReleaseProvider
28//! [`ReviewProvider`]: gitflow_core::review::ReviewProvider
29//! [`AuthProvider`]: gitflow_core::auth::AuthProvider
30//! [`LabelProvider`]: gitflow_core::label::LabelProvider
31//! [`MilestoneProvider`]: gitflow_core::label::MilestoneProvider
32//! [`CommitProvider`]: gitflow_core::commit::CommitProvider
33//! [`PipelineProvider`]: gitflow_core::pipeline::PipelineProvider
34//! [`CoreError::Platform`]: gitflow_core::CoreError::Platform
35
36#![forbid(unsafe_code)]
37#![allow(
38 clippy::doc_markdown,
39 reason = "GitCode is a platform brand name, not a Rust code item"
40)]
41#![cfg_attr(
42 test,
43 allow(
44 clippy::expect_used,
45 clippy::unwrap_used,
46 clippy::indexing_slicing,
47 clippy::useless_format,
48 clippy::clone_on_copy,
49 reason = "Tests legitimately need to unwrap fixture data and index into known-shape \
50 collections"
51 )
52)]
53
54pub mod auth;
55pub mod commit;
56pub mod error;
57pub mod issue;
58pub mod label;
59pub mod pipeline;
60pub mod pr;
61pub mod release;
62pub mod review;
63pub mod runner;
64
65pub use auth::GitCodeAuthProvider;
66pub use commit::GitCodeCommitProvider;
67pub use error::parse_gitcode_error;
68pub use issue::GitCodeIssueProvider;
69pub use label::{GitCodeLabelProvider, GitCodeMilestoneProvider};
70pub use pipeline::GitCodePipelineProvider;
71pub use pr::GitCodePrProvider;
72pub use release::GitCodeReleaseProvider;
73pub use review::GitCodeReviewProvider;
74
75/// Return the GitCode CLI binary path.
76///
77/// Prefers `gc` (Linux/macOS native name), falls back to `gitcode` (cross-platform).
78/// Searches PATH first, then pip user install directories
79/// (`~/Library/Python/*/bin/` on macOS, `~/.local/bin/` on Linux).
80#[allow(
81 clippy::disallowed_methods,
82 reason = "binary discovery runs at startup before async runtime is ready"
83)]
84pub(crate) fn gitcode_binary() -> String {
85 const CANDIDATES: &[&str] = &["gc", "gitcode"];
86
87 // 1. which <candidate> (pip/wheel/DEB/RPM install)
88 for &candidate in CANDIDATES {
89 if let Ok(p) = which::which(candidate) {
90 return p.to_string_lossy().into_owned();
91 }
92 }
93 // 2. pip user install paths (e.g. ~/Library/Python/3.9/bin/)
94 if let Ok(home) = std::env::var("HOME") {
95 for &candidate in CANDIDATES {
96 let lib = std::path::PathBuf::from(&home).join("Library/Python");
97 if let Ok(entries) = std::fs::read_dir(&lib) {
98 for entry in entries.flatten() {
99 let p = entry.path().join("bin").join(candidate);
100 if p.exists() {
101 return p.to_string_lossy().into_owned();
102 }
103 }
104 }
105 // Also check ~/.local/bin
106 let p = std::path::PathBuf::from(&home)
107 .join(".local/bin")
108 .join(candidate);
109 if p.exists() {
110 return p.to_string_lossy().into_owned();
111 }
112 }
113 }
114 // 3. Desperate fallback — prefer gc
115 "gc".into()
116}
117
118#[cfg(test)]
119mod tests {
120 use super::*;
121
122 #[test]
123 fn test_should_return_non_empty_binary_name() {
124 let binary = gitcode_binary();
125 assert!(!binary.is_empty());
126 }
127}