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

git_stk/
settings.rs
