utils-code/wfxr.forgit
1
0
Fork 0
mirror of https://github.com/wfxr/forgit.git synced 2026-09-10 07:16:23 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

feat: add option to disable auto creating branches (#552)
Some checks failed
ci / build (macos-latest) (push) Has been cancelled
Details
ci / build (ubuntu-latest) (push) Has been cancelled
Details
ci / commitlint (push) Has been cancelled
Details
ci / format (push) Has been cancelled
Details
ci / rumdl-check (push) Has been cancelled
Details
ci / actionlint (push) Has been cancelled
Details

Browse source 
Adds `$FORGIT_SWITCH_AUTO_CREATE_BRANCH` and `$FORGIT_CHECKOUT_BRANCH_AUTO_CREATE_BRANCH`
environment variables that can be set to `false` to prevent `checkout_branch <BRANCH_NAME>` and
`switch_brach <BRANCH_NAME>` from creating new branches when they do not exist. With the environment
variables set to `false`, new branches can still be created explicitly using
`switch_branch -c <BRANCH_NAME>` and `<checkout_branch> -c <BRANCH_NAME>` respectively.
This commit is contained in:
sandroid 2026-09-02 00:58:17 +02:00 committed by GitHub
parent 503c60ea35
commit 0fbd9edd87
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 118 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -371,17 +371,19 @@ export FORGIT_LOG_FZF_OPTS='
### Other Options
| Option | Description | Default |
|--------------------------------|--------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------|
| `FORGIT_LOG_FORMAT` | git log format | `%C(auto)%h%d %s %C(black)%C(bold)%cr%Creset` |
| `FORGIT_GLO_FORMAT` | override log format for `glo` command | `$FORGIT_LOG_FORMAT` |
| `FORGIT_LOG_GRAPH_ENABLE` | enable log graph display | `true` |
| `FORGIT_COPY_CMD` | command for copying to clipboard | `pbcopy` |
| `FORGIT_PREVIEW_CONTEXT` | lines of diff context in preview mode | 3 |
| `FORGIT_FULLSCREEN_CONTEXT` | lines of diff context in full-screen mode | 10 |
| `FORGIT_DIR_VIEW` | command used to preview directories | `tree` if available, otherwise `find` |
| `FORGIT_CLEAN_LIST_FILES_OPTS` | arguments passed to `git ls-files` together with `--others` to determine which files are shown when invoking `forgit clean` | |
| `FORGIT_WORKTREE_ADD_DIR` | directory where new worktrees are created | `<repo-root>/.wt` |
| Option | Description | Default |
| ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- |
| `FORGIT_LOG_FORMAT` | git log format | `%C(auto)%h%d %s %C(black)%C(bold)%cr%Creset` |
| `FORGIT_GLO_FORMAT` | override log format for `glo` command | `$FORGIT_LOG_FORMAT` |
| `FORGIT_LOG_GRAPH_ENABLE` | enable log graph display | `true` |
| `FORGIT_COPY_CMD` | command for copying to clipboard | `pbcopy` |
| `FORGIT_PREVIEW_CONTEXT` | lines of diff context in preview mode | 3 |
| `FORGIT_FULLSCREEN_CONTEXT` | lines of diff context in full-screen mode | 10 |
| `FORGIT_DIR_VIEW` | command used to preview directories | `tree` if available, otherwise `find` |
| `FORGIT_CLEAN_LIST_FILES_OPTS` | arguments passed to `git ls-files` together with `--others` to determine which files are shown when invoking `forgit clean` | |
| `FORGIT_WORKTREE_ADD_DIR` | directory where new worktrees are created | `<repo-root>/.wt` |
| `FORGIT_CHECKOUT_BRANCH_AUTO_CREATE_BRANCH` | prevents forgit from auto creating a new branch with `gcb <BRANCH_NAME>` when `<BRANCH_NAME>` does not exist when set to `false` | |
| `FORGIT_SWITCH_AUTO_CREATE_BRANCH` | prevents forgit from auto creating a new branch with `gsw <BRANCH_NAME>` when `<BRANCH_NAME>` does not exist when set to `false` | |
⌨ Keybindings
---------------

6
bin/git-forgit
View file

@ -1202,8 +1202,9 @@ _forgit_git_checkout_branch() {
_forgit_checkout_branch() {
_forgit_inside_work_tree || return 1
# if called with arguments, check if branch exists, else create a new one
# this behavior can be disabled by setting FORGIT_CHECKOUT_BRANCH_AUTO_CREATE_BRANCH to false
if [[ $# -ne 0 ]]; then
if [[ $* == "-" ]] || git show-branch "$@" &>/dev/null; then
if [[ $FORGIT_CHECKOUT_BRANCH_AUTO_CREATE_BRANCH == false ]] || [[ $* == "-" ]] || git show-branch "$@" &>/dev/null; then
git switch "$@"
else
git switch -c "$@"
@ -1248,8 +1249,9 @@ _forgit_git_switch_branch() {
_forgit_switch_branch() {
_forgit_inside_work_tree || return 1
# if called with arguments, check if branch exists, else create a new one
# this behavior can be disabled by setting FORGIT_SWITCH_AUTO_CREATE_BRANCH to false
if [[ $# -ne 0 ]]; then
if [[ $* == "-" ]] || git show-branch "$@" &>/dev/null; then
if [[ $FORGIT_SWITCH_AUTO_CREATE_BRANCH == false ]] || [[ $* == "-" ]] || git show-branch "$@" &>/dev/null; then
git switch "$@"
else
git switch -c "$@"

50
tests/checkout-branch.test.sh Normal file
View file

@ -0,0 +1,50 @@
#!/usr/bin/env bash
function set_up_before_script() {
source bin/git-forgit
# Ignore global git config files
export GIT_CONFIG_SYSTEM=/dev/null
export GIT_CONFIG_GLOBAL=/dev/null
# Create a temporary git repository for testing
cd "$(bashunit::temp_dir)" || return 1
git init -q
git config user.email "test@example.com"
git config user.name "Test User"
git commit -q --allow-empty -m "initial commit"
git branch existing-branch
}
function test_checkout_branch_creates_branch_when_it_does_not_exist() {
_forgit_checkout_branch auto-created-branch &>/dev/null
assert_exit_code "0"
assert_same "auto-created-branch" "$(git branch --show-current)"
}
function test_checkout_branch_does_not_create_branch_when_auto_create_is_disabled() {
FORGIT_CHECKOUT_BRANCH_AUTO_CREATE_BRANCH=false
_forgit_checkout_branch not-created-branch &>/dev/null
assert_exit_code "128"
assert_not_same "not-created-branch" "$(git branch --show-current)"
}
function test_checkout_branch_switches_to_existing_branch() {
_forgit_checkout_branch existing-branch &>/dev/null
assert_exit_code "0"
assert_same "existing-branch" "$(git branch --show-current)"
}
function test_checkout_branch_switches_to_existing_branch_when_auto_create_is_disabled() {
FORGIT_CHECKOUT_BRANCH_AUTO_CREATE_BRANCH=false
_forgit_checkout_branch existing-branch &>/dev/null
assert_exit_code "0"
assert_same "existing-branch" "$(git branch --show-current)"
}
function test_checkout_branch_creates_branch_when_requested_when_auto_create_is_disabled() {
FORGIT_CHECKOUT_BRANCH_AUTO_CREATE_BRANCH=false
_forgit_checkout_branch -c explicitly-created-branch &>/dev/null
assert_exit_code "0"
assert_same "explicitly-created-branch" "$(git branch --show-current)"
}

51
tests/switch-branch.test.sh Normal file
View file

@ -0,0 +1,51 @@
#!/usr/bin/env bash
function set_up_before_script() {
source bin/git-forgit
# Ignore global git config files
export GIT_CONFIG_SYSTEM=/dev/null
export GIT_CONFIG_GLOBAL=/dev/null
# Create a temporary git repository for testing
cd "$(bashunit::temp_dir)" || return 1
git init -q
git config user.email "test@example.com"
git config user.name "Test User"
git commit -q --allow-empty -m "initial commit"
git branch existing-branch
}
function test_switch_branch_creates_branch_when_it_does_not_exist() {
_forgit_switch_branch auto-created-branch &>/dev/null
assert_exit_code "0"
assert_same "auto-created-branch" "$(git branch --show-current)"
}
function test_switch_branch_does_not_create_branch_when_auto_create_is_disabled() {
FORGIT_SWITCH_AUTO_CREATE_BRANCH=false
_forgit_switch_branch not-created-branch &>/dev/null
assert_exit_code "128"
assert_not_contains "not-created-branch" "$(git branch --list --format='%(refname:short)')"
}
function test_switch_branch_switches_to_existing_branch() {
FORGIT_SWITCH_AUTO_CREATE_BRANCH=false
_forgit_switch_branch existing-branch &>/dev/null
assert_exit_code "0"
assert_same "existing-branch" "$(git branch --show-current)"
}
function test_switch_branch_switches_to_existing_branch_when_auto_create_is_disabled() {
FORGIT_SWITCH_AUTO_CREATE_BRANCH=false
_forgit_switch_branch existing-branch &>/dev/null
assert_exit_code "0"
assert_same "existing-branch" "$(git branch --show-current)"
}
function test_switch_branch_creates_branch_when_requested_when_auto_create_is_disabled() {
FORGIT_SWITCH_AUTO_CREATE_BRANCH=false
_forgit_switch_branch -c explicitly-created-branch &>/dev/null
assert_exit_code "0"
assert_same "explicitly-created-branch" "$(git branch --show-current)"
}