git_stk/
settings.rs

1//! Every stk-owned git config key and its resolution logic, in one place.
2
3use anyhow::Result;
4
5use crate::cli::PushMode;
6use crate::git;
7
8pub const PROVIDER_KEY: &str = "stk.provider";
9pub const REMOTE_KEY: &str = "stk.remote";
10pub const UPDATE_REFS_KEY: &str = "stk.updateRefs";
11pub const PUSH_ON_RESTACK_KEY: &str = "stk.pushOnRestack";
12pub const PUSH_ON_SUBMIT_KEY: &str = "stk.pushOnSubmit";
13pub const SUBMIT_STACK_KEY: &str = "stk.submitStack";
14pub const MERGE_STRATEGY_KEY: &str = "stk.mergeStrategy";
15pub const MERGE_WAIT_KEY: &str = "stk.mergeWait";
16pub const SUBMIT_DRAFT_KEY: &str = "stk.submitDraft";
17pub const NO_UPDATE_CHECK_KEY: &str = "stk.noUpdateCheck";
18pub const ABSORB_INCLUDE_UNSTAGED_KEY: &str = "stk.absorbIncludeUnstaged";
19pub const DEFAULT_REMOTE: &str = "origin";
20
21/// Every `[stk]` setting the tool reads, with its default behavior. Shown by
22/// `git stk config`.
23pub const SETTINGS: &[(&str, &str)] = &[
24    (PROVIDER_KEY, "auto-detect from the remote URL"),
25    (REMOTE_KEY, DEFAULT_REMOTE),
26    (UPDATE_REFS_KEY, "false"),
27    (PUSH_ON_RESTACK_KEY, "false"),
28    (PUSH_ON_SUBMIT_KEY, "false"),
29    (SUBMIT_STACK_KEY, "false"),
30    (MERGE_STRATEGY_KEY, "squash"),
31    (MERGE_WAIT_KEY, "false"),
32    (SUBMIT_DRAFT_KEY, "false"),
33    (NO_UPDATE_CHECK_KEY, "false"),
34    (ABSORB_INCLUDE_UNSTAGED_KEY, "false"),
35];
36
37/// The remote used for provider detection, trunk discovery, and pushes.
38pub fn remote() -> Result<String> {
39    Ok(git::config_get(REMOTE_KEY)?.unwrap_or_else(|| DEFAULT_REMOTE.to_owned()))
40}
41
42/// The merge strategy for `git stk merge`: squash, rebase, or merge.
43pub fn merge_strategy() -> Result<String> {
44    let strategy = git::config_get(MERGE_STRATEGY_KEY)?.unwrap_or_else(|| "squash".to_owned());
45    match strategy.as_str() {
46        "squash" | "rebase" | "merge" => Ok(strategy),
47        other => anyhow::bail!(
48            "unsupported stk.mergeStrategy value {other:?}; expected squash, rebase, or merge"
49        ),
50    }
51}
52
53/// A boolean setting's value, defaulting to false when unset.
54pub fn bool_setting(key: &str) -> Result<bool> {
55    Ok(git::config_get_bool(key)?.unwrap_or(false))
56}
57
58/// Resolve a `--push`/`--no-push` flag pair against its config-key default.
59pub fn push_enabled(mode: PushMode, key: &str) -> Result<bool> {
60    match mode {
61        PushMode::Config => Ok(git::config_get_bool(key)?.unwrap_or(false)),
62        PushMode::Enabled => Ok(true),
63        PushMode::Disabled => Ok(false),
64    }
65}
git_stk/settings.rs

git_stk/
settings.rs
