Struct WorkonConfig 

pub struct WorkonConfig<'repo> { /* private fields */ }

Configuration reader for workon settings stored in git config.

This struct provides access to workon-specific configuration keys, handling precedence between CLI arguments, local config, and global config.

Implementations

impl<'repo> WorkonConfig<'repo>

pub fn new(repo: &'repo Repository) -> Result<Self>

Create a new config reader for the given repository.

This opens the repository’s git config, which automatically handles precedence: local config (.git/config) > global config (~/.gitconfig) > system config.

pub fn default_branch( &self, cli_override: Option<&str>, ) -> Result<Option<String>>

Get the default branch to use when creating new worktrees.

Precedence: CLI override > workon.defaultBranch config > None

Returns None if not configured. Callers can fall back to init.defaultBranch or “main”.

pub fn pr_format(&self, cli_override: Option<&str>) -> Result<String>

Get the format string for PR-based worktree names.

Precedence: CLI override > workon.prFormat config > “pr-{number}”

The format string must contain {number} placeholder for the PR number. Returns an error if the format is invalid.

pub fn post_create_hooks(&self) -> Result<Vec<String>>

Get the list of post-create hook commands to run after worktree creation.

Reads from multi-value workon.postCreateHook config. Returns empty Vec if not configured.

pub fn copy_patterns(&self) -> Result<Vec<String>>

Get the list of glob patterns for files to copy between worktrees.

Reads from multi-value workon.copyPattern config. Returns empty Vec if not configured.

pub fn copy_excludes(&self) -> Result<Vec<String>>

Get the list of glob patterns for files to exclude from copying.

Reads from multi-value workon.copyExclude config. Returns empty Vec if not configured.

pub fn copy_include_ignored(&self, cli_override: Option<bool>) -> Result<bool>

Get whether to include git-ignored files when copying untracked files.

Precedence: CLI override > workon.copyIncludeIgnored config > false

When enabled, files matching .gitignore (e.g., .env.local, node_modules/) will also be included as copy candidates.

pub fn auto_copy_untracked(&self, cli_override: Option<bool>) -> Result<bool>

Get whether to automatically copy untracked files when creating new worktrees.

Precedence: CLI override > workon.autoCopyUntracked config > false

When enabled, files matching workon.copyPattern (excluding workon.copyExclude) will be automatically copied from the base worktree to the new worktree.

pub fn prune_protected_branches(&self) -> Result<Vec<String>>

Get the list of branch patterns to protect from pruning.

Reads from multi-value workon.pruneProtectedBranches config. Patterns support simple glob matching (* and ?). Returns empty Vec if not configured.

pub fn is_protected(&self, branch_name: &str) -> bool

Check if a given branch name is protected from pruning.

Returns true if the branch name matches any of the protected patterns.

pub fn hook_timeout(&self) -> Result<Duration>

Get the timeout duration for hook execution.

Reads from workon.hookTimeout config (integer seconds). Default: 300 seconds (5 minutes). A value of 0 disables the timeout.