Struct Config

pub struct Config {
    pub file: ConfigFile,
    pub path: Utf8PathBuf,
    pub cli: Cli,
    /* private fields */
}

Configuration, both from the command-line and a user configuration file.

Fields

file: ConfigFile

User configuration file.

path: Utf8PathBuf

User configuration file path.

cli: Cli

Command-line options.

Implementations

impl Config

pub const DEFAULT: &str = "# Configuration for `git-prole(1)`, a `git-worktree(1)` manager.\n# See: https://github.com/9999years/git-prole\n# All settings are listed here with their default values.\n\n# When determining a default remote or branch for a repository, the following\n# remotes will be tried, in order:\n#\n# 1. Git\'s `checkout.defaultRemote` setting.\n# 2. Any remotes listed here.\n#\n# This is used to pick a default branch; see `default_branches`.\nremote_names = [\n \"upstream\",\n \"origin\",\n]\n\n# When determining a default branch for a repository, the following branches\n# will be tried in order:\n#\n# 1. The default branch of the default remote (see `remotes`), as determined by\n# `git ls-remote --symref \"$REMOTE\" HEAD`.\n# 2. Any branches listed here.\n#\n# When `git prole convert` is used to convert a repository to a worktree\n# checkout, the main worktree will be checked out to the default branch.\n#\n# When `git prole add` is used to create a new worktree, if a new branch is\n# created, the branch will be set to the default branch unless another starting\n# point is given explicitly.\nbranch_names = [\n \"main\",\n \"master\",\n \"trunk\",\n]\n\n# Clone a repository into a worktree repository.\n#\n# `man git-prole-clone`\n[clone]\n# When you run `git prole clone foo/bar`, if `enable_gh = true` and `gh` is\n# installed, I\'ll run `gh repo clone foo/bar` as a shortcut for GitHub\n# repositories.\n#\n# See: https://cli.github.com/\nenable_gh = false\n\n# Add a new worktree to the current repository.\n#\n# `man git-prole-add`\n[add]\n# When `git prole add` is used to create a new worktree, `.gitignored` files\n# are copied to the new worktree from the current worktree by default.\n#\n# This will allow you to get started quickly by copying build products and\n# other configuration files over to the new worktree. However, copying these\n# files can take some time, so this setting can be used to disable this\n# behavior if needed.\n#\n# Note: Untracked files which are not ignored will not be copied.\n#\n# See: `man \'gitignore(5)\'`\ncopy_ignored = true\n\n# Commands to run when a new worktree is added.\ncommands = [\n # \"direnv allow\",\n # { sh = \'\'\'\n # if [ -e flake.nix ]; then\n # nix develop --command true\n # fi\n # \'\'\' },\n]\n\n# A list of regex replacements which are applied to branch names to determine\n# directory names.\n#\n# This settings is also used by `git prole convert` to resolve branch names\n# into directory names.\n#\n# For syntax, see: https://docs.rs/regex/latest/regex/#syntax\n#\n# By default, when you create a worktree for a branch with a `/` in it, `git\n# prole` will use the last component of the name; e.g., `git prole add\n# -b puppy/doggy` creates a directory named `doggy` for a new branch\n# `puppy/doggy`.\n#\n# However, this might not be the most convenient behavior for you, so you can\n# substitute this behavior with a series of regex replacements instead.\n#\n# For example, my ticket tracker at work auto-generates branch names like\n# `rebeccat/team-1234-some-ticket-title-which-is-way-too-long`. With\n# configuration like this:\n#\n# [[add.branch_replacements]]\n# find = \'\'\'\\w+/\\w{1,4}-\\d{1,5}-(\\w+(?:-\\w+){0,2}).*\'\'\'\n# replace = \'\'\'$1\'\'\'\n#\n# `git prole add -b ...` will create a directory named `some-ticket-title`.\n# (The branch name will still be unchanged and way too long.)\n#\n# Note that if the result of applying your regex substitutions includes a `/`,\n# the last component of the result will be used.\n#\n# For completeness, you can also specify how many replacements are performed:\n#\n# [[add.branch_replacements]]\n# find = \'\'\'puppy\'\'\'\n# replace = \'\'\'doggy\'\'\'\n# count = 1\nbranch_replacements = []\n"

The contents of the default configuration file.

pub fn new() -> Result<Self>

Trait Implementations

impl<C> AsRef<Config> for AppGit<'_, C>

fn as_ref(&self) -> &Config

Converts this type into a shared reference of the (usually inferred) input type.

impl Debug for Config

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.