Skip to content

Add heuristic for finding default remote name #2318

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add heuristic for finding default remote name #2318

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions lib/helpers.bash
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ function _bash-it-update-() {
fi

if [[ -z "$BASH_IT_REMOTE" ]]; then
BASH_IT_REMOTE="origin"
BASH_IT_REMOTE=$(_remote_name)
fi

git fetch "$BASH_IT_REMOTE" --tags &> /dev/null
Expand Down Expand Up @@ -352,7 +352,7 @@ function _bash-it-version() {
pushd "${BASH_IT?}" > /dev/null || return

if [[ -z "${BASH_IT_REMOTE:-}" ]]; then
BASH_IT_REMOTE="origin"
BASH_IT_REMOTE=$(_remote_name)
fi

BASH_IT_GIT_REMOTE="$(git remote get-url "$BASH_IT_REMOTE")"
Expand Down Expand Up @@ -951,6 +951,24 @@ function pathmunge() {
fi
}

function _remote_name() {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I looked over the repo, looks like there is already code covering remote name detection in themes/githelpers.theme.bash

Maybe it's not a bad idea for code reuse, to move this function library to the general libraries and have those functions available globally and not just for a small number of themes that bother to source it.

Any thoughts, @akinomyoga ?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(either way, if we keep this, maybe name it a bit more descrive, like _get_git_default_remote() )

Copy link
Contributor

@akinomyoga akinomyoga Jun 9, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the target repositories are different. The functions _bash-it-{update-,version} modified in this PR are intended to retrieve the remote in the repository of Bash-It itself, while githelpers.theme.sh is supposed to retrieve information in the repository of the current working directory.

edit: I think it would be valid to prepare a function to get the remote name in the current git tree and use it everywhere. For the present purpose, the function can be used as $(cd "$BASH_IT"; _bash-it-git-get-remote-host). However, the feature to determine the remote name doesn't seem to exist in githelpers.theme.sh. I think unless the same feature is required by both themes and the bash-it command, we don't necessarily have to define the function in a single place.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure how much the contribution guideline is strictly applied to the project, but Coding Style - docs/contributing.rst says

  • When creating new functions, please use a dash ("-") to separate the words of the function's name, e.g. my-new-function. Don't use underscores, e.g. my_new_function.
  • Internal functions that aren't to be used by the end user should start with an underscore, e.g. _my-new-internal-function.

local branch
branch=$(git branch --show-current)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't this get the information about the git repository of the current working directory? Shouldn't this get the information in the Bash-it repository?


local remote_name=
remote_name=$(git config --get --default '' "branch.$branch.remote")
if [[ -n "$remote_name" ]]; then
printf '%s\n' "$remote_name"
return
fi

if remote_name=$(git remote -v | awk 'NR==1 { name=$1; print name } $1 != name { exit 1 }'); then
printf '%s\n' "$remote_name"
else
printf '%s\n' 'origin'
fi
}

# `_bash-it-find-in-ancestor` uses the shell's ability to run a function in
# a subshell to simplify our search to a simple `cd ..` and `[[ -r $1 ]]`
# without any external dependencies. Let the shell do what it's good at.
Expand Down
Loading