Add *_PREVIEW_GIT_OPTS variables #396

ccoVeille · 2024-07-17T16:12:28Z

Check list

I have performed a self-review of my code
I have commented my code in hard-to-understand areas
I have made corresponding changes to the documentation

Description

These variables can be used to tune the rendering of the previews

The following example allows listing the content of the stash before
opening it.

FORGIT_STASH_SHOW_PREVIEW_GIT_OPTS="--patch-with-stat --stat-count=10"

Type of change

Test environment

Shell
- bash
- zsh
- fish
OS
- Linux
- Mac OS X
- Windows
- Others:

Fixes #391

These variables can be used to tune the rendering of the previews The following example allows listing the content of the stash before opening it. FORGIT_STASH_SHOW_PREVIEW_GIT_OPTS="--patch-with-stat --stat-count=10"

ccoVeille · 2024-07-17T16:14:11Z

This is a WIP code change, I made the changes, but I didn't test them all now.

You can still review it now, as the review will be mostly about variables naming and documentation I think

So please review

ccoVeille · 2024-07-18T19:42:25Z

maybe @carlfriedrich @sandr01d ?

sandr01d · 2024-07-18T21:06:45Z

I will give you a review, but I'm currently very busy and won't make it today. I'll try to find the time tomorrow.

ccoVeille · 2024-07-19T08:56:52Z

No rush. I was busy for months. This PR can wait weeks, no worries

sandr01d

Thanks for your great work @ccoVeille! This is going in the right direction. Most of my comments are me being nitpicky about documentation and a few white space changes that slipped into this PR. I will do a full functional test once the PR has been finalized.

sandr01d · 2024-07-19T20:25:25Z

README.md


 ```shell
 export FORGIT_CHECKOUT_BRANCH_BRANCH_GIT_OPTS='--sort=-committerdate'
 ```

+- if you want to see a preview of the stashed items in `gss` preview, you could:


Suggested change

- if you want to see a preview of the stashed items in `gss` preview, you could:

- if you want to see a overview of the stashed items in `gss` preview, you could:

I think overview communicates the options from the example better here, since we already use the term preview for the diff that is being displayed.

sandr01d · 2024-07-19T20:26:22Z

README.md

 If you want to customize `git`'s behavior within forgit there is a dedicated variable for each forgit command.
 These are passed to the according `git` calls.


Suggested change

If you want to customize `git`'s behavior within forgit there is a dedicated variable for each forgit command.

These are passed to the according `git` calls.

If you want to customize `git`'s behavior within forgit there are dedicated variables for each forgit command.

These are passed to the according `git` calls.

sandr01d · 2024-07-19T20:29:53Z

README.md

+| `gbd`    | `FORGIT_BRANCH_DELETE_GIT_OPTS`                                              |
+| `gct`    | `FORGIT_CHECKOUT_TAG_GIT_OPTS`                                               |
+| `gco`    | `FORGIT_CHECKOUT_COMMIT_GIT_OPTS`, `FORGIT_CHECKOUT_COMMIT_PREVIEW_GIT_OPTS` |
+| `grc`    | `FORGIT_REVERT_COMMIT_GIT_OPTS`, `FORGIT_REVERT_PREVIEW_GIT_OPTS`            |


Wondering whether we should go with FORGIT_REVERT_COMMIT_PREVIEW_GIT_OPTS here. The name is a bit long, but it would be consistent with the existing FORGIT_REVERT_COMMIT_GIT_OPTS.

sandr01d · 2024-07-19T20:30:17Z

bin/git-forgit

@@ -169,7 +169,7 @@ _forgit_list_files() {
    # unquoted.
    # uniq is necessary because unmerged files are printed once for each
    # merge conflict.
-    # With the -z flag, git also uses \0 line termination, so we 
+    # With the -z flag, git also uses \0 line termination, so we


There is a white space change that should not be here.

sandr01d · 2024-07-19T20:37:29Z

README.md

+|----------|------------------------------------------------------------------------------|
+| `ga`     | `FORGIT_ADD_GIT_OPTS`, `FORGIT_ADD_PREVIEW_GIT_OPTS`                         |
+| `glo`    | `FORGIT_LOG_GIT_OPTS`, `FORGIT_LOG_PREVIEW_GIT_OPTS`                         |
+| `gd`     | `FORGIT_DIFF_GIT_OPTS`                                                       |
+| `grh`    | `FORGIT_RESET_HEAD_GIT_OPTS`, `FORGIT_RESET_HEAD_PREVIEW_GIT_OPTS`           |
+| `gcf`    | `FORGIT_CHECKOUT_FILE_GIT_OPTS`, `FORGIT_CHECKOUT_FILE_PREVIEW_GIT_OPTS`     |
+| `gcb`    | `FORGIT_CHECKOUT_BRANCH_GIT_OPTS`, `FORGIT_CHECKOUT_BRANCH_BRANCH_GIT_OPTS`  |
+| `gbd`    | `FORGIT_BRANCH_DELETE_GIT_OPTS`                                              |
+| `gct`    | `FORGIT_CHECKOUT_TAG_GIT_OPTS`                                               |
+| `gco`    | `FORGIT_CHECKOUT_COMMIT_GIT_OPTS`, `FORGIT_CHECKOUT_COMMIT_PREVIEW_GIT_OPTS` |
+| `grc`    | `FORGIT_REVERT_COMMIT_GIT_OPTS`, `FORGIT_REVERT_PREVIEW_GIT_OPTS`            |
+| `gss`    | `FORGIT_STASH_SHOW_GIT_OPTS`, `FORGIT_STASH_SHOW_PREVIEW_GIT_OPTS`           |
+| `gsp`    | `FORGIT_STASH_PUSH_GIT_OPTS`, `FORGIT_STASH_PUSH_PREVIEW_GIT_OPTS`           |
+| `gclean` | `FORGIT_CLEAN_GIT_OPTS`, `FORGIT_CLEAN_PREVIEW_GIT_OPTS`                     |
+| `grb`    | `FORGIT_REBASE_GIT_OPTS`, `FORGIT_FILE_PREVIEW_GIT_OPTS`                     |
+| `gbl`    | `FORGIT_BLAME_GIT_OPTS`                                                      |
+| `gfu`    | `FORGIT_FIXUP_GIT_OPTS`, `FORGIT_FILE_PREVIEW_GIT_OPTS`                      |
+| `gcp`    | `FORGIT_CHERRY_PICK_GIT_OPTS`, `FORGIT_CHERRY_PICK_PREVIEW_GIT_OPTS`         |


We should probably note down somewhere which git commands the *_PREVIEW_GIT_OPTS are used with to let people know which arguments they can use, e.g. it might not be obvious to everyone that FORGIT_LOG_PREVIEW_GIT_OPTS is used with git show. Might also make sense to break this out into a separate table if it does not fit into this one.

sandr01d · 2024-07-19T20:39:26Z

bin/git-forgit

@@ -531,7 +545,7 @@ _forgit_cherry_pick() {
    [[ -z $1 ]] && echo "Please specify target branch" && return 1
    target="$1"

-    # in this function, we do something interesting to maintain proper ordering as it's assumed 
+    # in this function, we do something interesting to maintain proper ordering as it's assumed


...another white space change here

sandr01d · 2024-07-19T20:39:48Z

bin/git-forgit

@@ -555,14 +569,16 @@ _forgit_cherry_pick() {
        commits+=("$commit")
    done < <(echo "$fzf_selection" | sort -n -k 1 | cut -f2 | cut -d' ' -f1 | _forgit_reverse_lines)
    [ ${#commits[@]} -eq 0 ] && return 1
-    
+


...and here

sandr01d · 2024-07-19T20:41:11Z

bin/git-forgit

@@ -858,7 +882,7 @@ _forgit_revert_commit() {
    graph=()
    [[ $_forgit_log_graph_enable == true ]] && graph=(--graph)

-    # in this function, we do something interesting to maintain proper ordering as it's assumed 
+    # in this function, we do something interesting to maintain proper ordering as it's assumed


...and here

sandr01d · 2024-07-19T20:41:14Z

bin/git-forgit

@@ -871,7 +895,7 @@ _forgit_revert_commit() {
        _forgit_emojify |
        nl |
        FZF_DEFAULT_OPTS="$opts" fzf |
-        sort -n -k 1 | 
+        sort -n -k 1 |


...and here

ccoVeille · 2024-07-21T07:24:36Z

I'm in holidays, without computer and with limited and sporadic internet connection.

I'll give be back in about a week, and will then take a look at your feedbacks

ccoVeille · 2024-08-03T10:25:12Z

I'm still busy, I'll be back to normal in the next weeks.

Add *_PREVIEW_GIT_OPTS variables

0fd316b

These variables can be used to tune the rendering of the previews The following example allows listing the content of the stash before opening it. FORGIT_STASH_SHOW_PREVIEW_GIT_OPTS="--patch-with-stat --stat-count=10"

ccoVeille marked this pull request as draft July 17, 2024 16:12

ccoVeille mentioned this pull request Jul 17, 2024

Add FORGIT_STASH_SHOW_PREVIEW_GIT_OPTS #389

Closed

15 tasks

sandr01d requested changes Jul 19, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add *_PREVIEW_GIT_OPTS variables #396

Add *_PREVIEW_GIT_OPTS variables #396

ccoVeille commented Jul 17, 2024

ccoVeille commented Jul 17, 2024

ccoVeille commented Jul 18, 2024

sandr01d commented Jul 18, 2024

ccoVeille commented Jul 19, 2024

sandr01d left a comment

sandr01d Jul 19, 2024

sandr01d Jul 19, 2024 •

edited

Loading

sandr01d Jul 19, 2024

sandr01d Jul 19, 2024

sandr01d Jul 19, 2024

sandr01d Jul 19, 2024

sandr01d Jul 19, 2024

sandr01d Jul 19, 2024

sandr01d Jul 19, 2024

ccoVeille commented Jul 21, 2024

ccoVeille commented Aug 3, 2024

	- if you want to see a preview of the stashed items in `gss` preview, you could:
	- if you want to see a overview of the stashed items in `gss` preview, you could:

		If you want to customize `git`'s behavior within forgit there is a dedicated variable for each forgit command.
		These are passed to the according `git` calls.

Add *_PREVIEW_GIT_OPTS variables #396

Are you sure you want to change the base?

Add *_PREVIEW_GIT_OPTS variables #396

Conversation

ccoVeille commented Jul 17, 2024

Check list

Description

Type of change

Test environment

ccoVeille commented Jul 17, 2024

ccoVeille commented Jul 18, 2024

sandr01d commented Jul 18, 2024

ccoVeille commented Jul 19, 2024

sandr01d left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sandr01d Jul 19, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ccoVeille commented Jul 21, 2024

ccoVeille commented Aug 3, 2024

sandr01d Jul 19, 2024 •

edited

Loading