Module branchless::core::config

Accesses repo-specific configuration.

Modules

• env_vars
  Environment variables which affect the functioning of git-branchless.

Enums

• Hint
  Possible hint types.

Constants

• RESTACK_WARN_ABANDONED_CONFIG_KEY
  Config key for get_restack_warn_abandoned.

Functions

• get_auto_switch_branches
  If true, switch to the branch associated with a target commit instead of the commit directly.
• get_comment_char
  Get the default comment character.
• get_commit_descriptors_branches
  If true, show branches pointing to each commit in the smartlog.
• get_commit_descriptors_differential_revision
  If true, show associated Phabricator commits in the smartlog.
• get_commit_descriptors_relative_time
  If true, show the age of each commit in the smartlog.
• get_commit_template
  Get the commit template message, if any.
• get_default_branch_name
  Get the default init branch name.
• get_default_hooks_dir
  Get the expected hooks dir inside .git, assuming that the user has not overridden it.
• get_editor
  Get the configured editor, if any.
• get_hint_enabled
  Determine if a given hint is enabled.
• get_hint_string
  Render the leading colored “hint” text for use in messaging.
• get_hooks_dir
  Get the path where Git hooks are stored on disk.
• get_main_branch_name
  Get the configured name of the main branch.
• get_next_interactive
  If true, when advancing to a “next” commit, prompt interactively to if there is ambiguity in which commit to advance to.
• get_restack_preserve_timestamps
  If true, when restacking a commit, do not update its timestamp to the current time.
• get_undo_create_snapshots
  If true, create working copy snapshots automatically after certain operations.
• print_hint_suppression_notice
  Print instructions explaining how to disable a given hint.