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

git_stk/
settings.rs
