Skip to content

Commit

Permalink
refactor: pull request review changes
Browse files Browse the repository at this point in the history
  • Loading branch information
@benelan
benelan committed Jul 16, 2024
1 parent 4994e44 commit 5e7d30b
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 26 deletions.
22 changes: 11 additions & 11 deletions gh-notify
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,17 +28,17 @@ export GH_NOTIFY_PER_PAGE_LIMIT=50
export GH_NOTIFY_DEBUG_MODE=${GH_NOTIFY_DEBUG_MODE:-false}

# Customize the fzf keys using environment variables
export GH_NOTIFY_RESIZE_PREVIEW_KEY="${GH_NOTIFY_RESIZE_PREVIEW_KEY:-"btab"}"
export GH_NOTIFY_TOGGLE_PREVIEW_KEY="${GH_NOTIFY_TOGGLE_PREVIEW_KEY:-"tab"}"
export GH_NOTIFY_VIEW_KEY="${GH_NOTIFY_VIEW_KEY:-"enter"}"
export GH_NOTIFY_TOGGLE_HELP_KEY="${GH_NOTIFY_TOGGLE_HELP_KEY:-"?"}"
export GH_NOTIFY_VIEW_DIFF_KEY="${GH_NOTIFY_VIEW_DIFF_KEY:-"ctrl-d"}"
export GH_NOTIFY_VIEW_PATCH_KEY="${GH_NOTIFY_VIEW_PATCH_KEY:-"ctrl-p"}"
export GH_NOTIFY_MARK_READ_KEY="${GH_NOTIFY_MARK_READ_KEY:-"ctrl-t"}"
export GH_NOTIFY_MARK_ALL_READ_KEY="${GH_NOTIFY_MARK_ALL_READ_KEY:-"ctrl-a"}"
export GH_NOTIFY_OPEN_BROWSER_KEY="${GH_NOTIFY_OPEN_BROWSER_KEY:-"ctrl-b"}"
export GH_NOTIFY_RELOAD_KEY="${GH_NOTIFY_RELOAD_KEY:-"ctrl-r"}"
export GH_NOTIFY_COMMENT_KEY="${GH_NOTIFY_COMMENT_KEY:-"ctrl-x"}"
: "${GH_NOTIFY_MARK_ALL_READ_KEY:=ctrl-a}"
: "${GH_NOTIFY_OPEN_BROWSER_KEY:=ctrl-b}"
: "${GH_NOTIFY_VIEW_DIFF_KEY:=ctrl-d}"
: "${GH_NOTIFY_VIEW_PATCH_KEY:=ctrl-p}"
: "${GH_NOTIFY_RELOAD_KEY:=ctrl-r}"
: "${GH_NOTIFY_MARK_READ_KEY:=ctrl-t}"
: "${GH_NOTIFY_COMMENT_KEY:=ctrl-x}"
: "${GH_NOTIFY_RESIZE_PREVIEW_KEY:=btab}"
: "${GH_NOTIFY_VIEW_KEY:=enter}"
: "${GH_NOTIFY_TOGGLE_PREVIEW_KEY:=tab}"
: "${GH_NOTIFY_TOGGLE_HELP_KEY:=?}"

if $GH_NOTIFY_DEBUG_MODE; then
export gh_notify_debug_log="${BASH_SOURCE%/*}/gh_notify_debug.log"
Expand Down
43 changes: 28 additions & 15 deletions readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,21 +48,21 @@ gh notify [Flags]

### Key Bindings fzf

| Keys | Description | Customization Environment Variable |
| ------------------------------ | --------------------------------------------------- | --------------------------------------- |
| <kbd>?</kbd> | toggle help | <kbd>GH_NOTIFY_TOGGLE_HELP_KEY</kbd> |
| <kbd>enter</kbd> | view the selected notification in the 'less' pager | <kbd>GH_NOTIFY_VIEW_KEY</kbd> |
| <kbd>tab</kbd> | toggle notification preview | <kbd>GH_NOTIFY_TOGGLE_PREVIEW_KEY</kbd> |
| <kbd>shift</kbd><kbd>tab</kbd> | resize the preview window | <kbd>GH_NOTIFY_RESIZE_PREVIEW_KEY</kbd> |
| <kbd>shift</kbd><kbd>↑↓</kbd> | scroll the preview up/ down | |
| <kbd>ctrl</kbd><kbd>a</kbd> | mark all displayed notifications as read and reload | <kbd>GH_NOTIFY_MARK_ALL_READ_KEY</kbd> |
| <kbd>ctrl</kbd><kbd>b</kbd> | browser | <kbd>GH_NOTIFY_OPEN_BROWSER_KEY</kbd> |
| <kbd>ctrl</kbd><kbd>d</kbd> | view diff | <kbd>GH_NOTIFY_VIEW_DIFF_KEY</kbd> |
| <kbd>ctrl</kbd><kbd>p</kbd> | view diff in patch format | <kbd>GH_NOTIFY_VIEW_PATCH_KEY</kbd> |
| <kbd>ctrl</kbd><kbd>r</kbd> | reload | <kbd>GH_NOTIFY_RELOAD_KEY</kbd> |
| <kbd>ctrl</kbd><kbd>t</kbd> | mark the selected notification as read and reload | <kbd>GH_NOTIFY_MARK_READ_KEY</kbd> |
| <kbd>ctrl</kbd><kbd>x</kbd> | write a comment with the editor and quit | <kbd>GH_NOTIFY_COMMENT_KEY</kbd> |
| <kbd>esc</kbd> | quit | |
| Keys | Description | Customization Environment Variable |
| ------------------------------ | --------------------------------------------------- | ---------------------------------- |
| <kbd>?</kbd> | toggle help | `GH_NOTIFY_TOGGLE_HELP_KEY` |
| <kbd>enter</kbd> | view the selected notification in the 'less' pager | `GH_NOTIFY_VIEW_KEY` |
| <kbd>tab</kbd> | toggle notification preview | `GH_NOTIFY_TOGGLE_PREVIEW_KEY` |
| <kbd>shift</kbd><kbd>tab</kbd> | resize the preview window | `GH_NOTIFY_RESIZE_PREVIEW_KEY` |
| <kbd>shift</kbd><kbd>↑↓</kbd> | scroll the preview up/ down | |
| <kbd>ctrl</kbd><kbd>a</kbd> | mark all displayed notifications as read and reload | `GH_NOTIFY_MARK_ALL_READ_KEY` |
| <kbd>ctrl</kbd><kbd>b</kbd> | browser | `GH_NOTIFY_OPEN_BROWSER_KEY` |
| <kbd>ctrl</kbd><kbd>d</kbd> | view diff | `GH_NOTIFY_VIEW_DIFF_KEY` |
| <kbd>ctrl</kbd><kbd>p</kbd> | view diff in patch format | `GH_NOTIFY_VIEW_PATCH_KEY` |
| <kbd>ctrl</kbd><kbd>r</kbd> | reload | `GH_NOTIFY_RELOAD_KEY` |
| <kbd>ctrl</kbd><kbd>t</kbd> | mark the selected notification as read and reload | `GH_NOTIFY_MARK_READ_KEY` |
| <kbd>ctrl</kbd><kbd>x</kbd> | write a comment with the editor and quit | `GH_NOTIFY_COMMENT_KEY` |
| <kbd>esc</kbd> | quit | |

### Table Format

Expand Down Expand Up @@ -100,6 +100,19 @@ export FZF_DEFAULT_OPTS="
--bind 'ctrl-w:preview-half-page-up,ctrl-s:preview-half-page-down'"
```

You can also customize the keybindings created by this extension to avoid conflicts with
the ones defined by `fzf`. For example, change `ctrl-p` to `ctrl-u`:

```sh
GH_NOTIFY_VIEW_PATCH_KEY="ctrl-u" gh notify
```

**NOTE:** The assigned key must be a valid key listed in the `fzf` man page:

```sh
man --pager='less -p "^\s+AVAILABLE_KEYS"' fzf
```

### GitHub Command Line Tool (gh)
In the `gh` tool's config file, you can specify your preferred editor. This is particularly useful
when you use the <kbd>ctrl</kbd><kbd>x</kbd> hotkey to comment on a notification.
Expand Down

0 comments on commit 5e7d30b

Please sign in to comment.