Skip to content

Commit

Permalink
feat: replace space with leader in default mappings
Browse files Browse the repository at this point in the history 
Makes default mappings compatible with people not using space as a `<leader>`.
  • Loading branch information
@pogopaule
pogopaule authored Oct 9, 2024
1 parent 29d4ed4 commit 0adcc6d
Show file tree
Hide file tree
Showing 4 changed files with 129 additions and 129 deletions.
128 changes: 64 additions & 64 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -167,89 +167,89 @@ require"octo".setup({
mappings_disable_default = false, -- disable default mappings if true, but will still adapt user mappings
mappings = {
issue = {
close_issue = { lhs = "<space>ic", desc = "close issue" },
reopen_issue = { lhs = "<space>io", desc = "reopen issue" },
list_issues = { lhs = "<space>il", desc = "list open issues on same repo" },
close_issue = { lhs = "<leader>ic", desc = "close issue" },
reopen_issue = { lhs = "<leader>io", desc = "reopen issue" },
list_issues = { lhs = "<leader>il", desc = "list open issues on same repo" },
reload = { lhs = "<C-r>", desc = "reload issue" },
open_in_browser = { lhs = "<C-b>", desc = "open issue in browser" },
copy_url = { lhs = "<C-y>", desc = "copy url to system clipboard" },
add_assignee = { lhs = "<space>aa", desc = "add assignee" },
remove_assignee = { lhs = "<space>ad", desc = "remove assignee" },
create_label = { lhs = "<space>lc", desc = "create label" },
add_label = { lhs = "<space>la", desc = "add label" },
remove_label = { lhs = "<space>ld", desc = "remove label" },
goto_issue = { lhs = "<space>gi", desc = "navigate to a local repo issue" },
add_comment = { lhs = "<space>ca", desc = "add comment" },
delete_comment = { lhs = "<space>cd", desc = "delete comment" },
add_assignee = { lhs = "<leader>aa", desc = "add assignee" },
remove_assignee = { lhs = "<leader>ad", desc = "remove assignee" },
create_label = { lhs = "<leader>lc", desc = "create label" },
add_label = { lhs = "<leader>la", desc = "add label" },
remove_label = { lhs = "<leader>ld", desc = "remove label" },
goto_issue = { lhs = "<leader>gi", desc = "navigate to a local repo issue" },
add_comment = { lhs = "<leader>ca", desc = "add comment" },
delete_comment = { lhs = "<leader>cd", desc = "delete comment" },
next_comment = { lhs = "]c", desc = "go to next comment" },
prev_comment = { lhs = "[c", desc = "go to previous comment" },
react_hooray = { lhs = "<space>rp", desc = "add/remove 🎉 reaction" },
react_heart = { lhs = "<space>rh", desc = "add/remove ❤️ reaction" },
react_eyes = { lhs = "<space>re", desc = "add/remove 👀 reaction" },
react_thumbs_up = { lhs = "<space>r+", desc = "add/remove 👍 reaction" },
react_thumbs_down = { lhs = "<space>r-", desc = "add/remove 👎 reaction" },
react_rocket = { lhs = "<space>rr", desc = "add/remove 🚀 reaction" },
react_laugh = { lhs = "<space>rl", desc = "add/remove 😄 reaction" },
react_confused = { lhs = "<space>rc", desc = "add/remove 😕 reaction" },
react_hooray = { lhs = "<leader>rp", desc = "add/remove 🎉 reaction" },
react_heart = { lhs = "<leader>rh", desc = "add/remove ❤️ reaction" },
react_eyes = { lhs = "<leader>re", desc = "add/remove 👀 reaction" },
react_thumbs_up = { lhs = "<leader>r+", desc = "add/remove 👍 reaction" },
react_thumbs_down = { lhs = "<leader>r-", desc = "add/remove 👎 reaction" },
react_rocket = { lhs = "<leader>rr", desc = "add/remove 🚀 reaction" },
react_laugh = { lhs = "<leader>rl", desc = "add/remove 😄 reaction" },
react_confused = { lhs = "<leader>rc", desc = "add/remove 😕 reaction" },
},
pull_request = {
checkout_pr = { lhs = "<space>po", desc = "checkout PR" },
merge_pr = { lhs = "<space>pm", desc = "merge commit PR" },
squash_and_merge_pr = { lhs = "<space>psm", desc = "squash and merge PR" },
rebase_and_merge_pr = { lhs = "<space>prm", desc = "rebase and merge PR" },
list_commits = { lhs = "<space>pc", desc = "list PR commits" },
list_changed_files = { lhs = "<space>pf", desc = "list PR changed files" },
show_pr_diff = { lhs = "<space>pd", desc = "show PR diff" },
add_reviewer = { lhs = "<space>va", desc = "add reviewer" },
remove_reviewer = { lhs = "<space>vd", desc = "remove reviewer request" },
close_issue = { lhs = "<space>ic", desc = "close PR" },
reopen_issue = { lhs = "<space>io", desc = "reopen PR" },
list_issues = { lhs = "<space>il", desc = "list open issues on same repo" },
checkout_pr = { lhs = "<leader>po", desc = "checkout PR" },
merge_pr = { lhs = "<leader>pm", desc = "merge commit PR" },
squash_and_merge_pr = { lhs = "<leader>psm", desc = "squash and merge PR" },
rebase_and_merge_pr = { lhs = "<leader>prm", desc = "rebase and merge PR" },
list_commits = { lhs = "<leader>pc", desc = "list PR commits" },
list_changed_files = { lhs = "<leader>pf", desc = "list PR changed files" },
show_pr_diff = { lhs = "<leader>pd", desc = "show PR diff" },
add_reviewer = { lhs = "<leader>va", desc = "add reviewer" },
remove_reviewer = { lhs = "<leader>vd", desc = "remove reviewer request" },
close_issue = { lhs = "<leader>ic", desc = "close PR" },
reopen_issue = { lhs = "<leader>io", desc = "reopen PR" },
list_issues = { lhs = "<leader>il", desc = "list open issues on same repo" },
reload = { lhs = "<C-r>", desc = "reload PR" },
open_in_browser = { lhs = "<C-b>", desc = "open PR in browser" },
copy_url = { lhs = "<C-y>", desc = "copy url to system clipboard" },
goto_file = { lhs = "gf", desc = "go to file" },
add_assignee = { lhs = "<space>aa", desc = "add assignee" },
remove_assignee = { lhs = "<space>ad", desc = "remove assignee" },
create_label = { lhs = "<space>lc", desc = "create label" },
add_label = { lhs = "<space>la", desc = "add label" },
remove_label = { lhs = "<space>ld", desc = "remove label" },
goto_issue = { lhs = "<space>gi", desc = "navigate to a local repo issue" },
add_comment = { lhs = "<space>ca", desc = "add comment" },
delete_comment = { lhs = "<space>cd", desc = "delete comment" },
add_assignee = { lhs = "<leader>aa", desc = "add assignee" },
remove_assignee = { lhs = "<leader>ad", desc = "remove assignee" },
create_label = { lhs = "<leader>lc", desc = "create label" },
add_label = { lhs = "<leader>la", desc = "add label" },
remove_label = { lhs = "<leader>ld", desc = "remove label" },
goto_issue = { lhs = "<leader>gi", desc = "navigate to a local repo issue" },
add_comment = { lhs = "<leader>ca", desc = "add comment" },
delete_comment = { lhs = "<leader>cd", desc = "delete comment" },
next_comment = { lhs = "]c", desc = "go to next comment" },
prev_comment = { lhs = "[c", desc = "go to previous comment" },
react_hooray = { lhs = "<space>rp", desc = "add/remove 🎉 reaction" },
react_heart = { lhs = "<space>rh", desc = "add/remove ❤️ reaction" },
react_eyes = { lhs = "<space>re", desc = "add/remove 👀 reaction" },
react_thumbs_up = { lhs = "<space>r+", desc = "add/remove 👍 reaction" },
react_thumbs_down = { lhs = "<space>r-", desc = "add/remove 👎 reaction" },
react_rocket = { lhs = "<space>rr", desc = "add/remove 🚀 reaction" },
react_laugh = { lhs = "<space>rl", desc = "add/remove 😄 reaction" },
react_confused = { lhs = "<space>rc", desc = "add/remove 😕 reaction" },
review_start = { lhs = "<space>vs", desc = "start a review for the current PR" },
review_resume = { lhs = "<space>vr", desc = "resume a pending review for the current PR" },
react_hooray = { lhs = "<leader>rp", desc = "add/remove 🎉 reaction" },
react_heart = { lhs = "<leader>rh", desc = "add/remove ❤️ reaction" },
react_eyes = { lhs = "<leader>re", desc = "add/remove 👀 reaction" },
react_thumbs_up = { lhs = "<leader>r+", desc = "add/remove 👍 reaction" },
react_thumbs_down = { lhs = "<leader>r-", desc = "add/remove 👎 reaction" },
react_rocket = { lhs = "<leader>rr", desc = "add/remove 🚀 reaction" },
react_laugh = { lhs = "<leader>rl", desc = "add/remove 😄 reaction" },
react_confused = { lhs = "<leader>rc", desc = "add/remove 😕 reaction" },
review_start = { lhs = "<leader>vs", desc = "start a review for the current PR" },
review_resume = { lhs = "<leader>vr", desc = "resume a pending review for the current PR" },
},
review_thread = {
goto_issue = { lhs = "<space>gi", desc = "navigate to a local repo issue" },
add_comment = { lhs = "<space>ca", desc = "add comment" },
add_suggestion = { lhs = "<space>sa", desc = "add suggestion" },
delete_comment = { lhs = "<space>cd", desc = "delete comment" },
goto_issue = { lhs = "<leader>gi", desc = "navigate to a local repo issue" },
add_comment = { lhs = "<leader>ca", desc = "add comment" },
add_suggestion = { lhs = "<leader>sa", desc = "add suggestion" },
delete_comment = { lhs = "<leader>cd", desc = "delete comment" },
next_comment = { lhs = "]c", desc = "go to next comment" },
prev_comment = { lhs = "[c", desc = "go to previous comment" },
select_next_entry = { lhs = "]q", desc = "move to next changed file" },
select_prev_entry = { lhs = "[q", desc = "move to previous changed file" },
select_first_entry = { lhs = "[Q", desc = "move to first changed file" },
select_last_entry = { lhs = "]Q", desc = "move to last changed file" },
close_review_tab = { lhs = "<C-c>", desc = "close review tab" },
react_hooray = { lhs = "<space>rp", desc = "add/remove 🎉 reaction" },
react_heart = { lhs = "<space>rh", desc = "add/remove ❤️ reaction" },
react_eyes = { lhs = "<space>re", desc = "add/remove 👀 reaction" },
react_thumbs_up = { lhs = "<space>r+", desc = "add/remove 👍 reaction" },
react_thumbs_down = { lhs = "<space>r-", desc = "add/remove 👎 reaction" },
react_rocket = { lhs = "<space>rr", desc = "add/remove 🚀 reaction" },
react_laugh = { lhs = "<space>rl", desc = "add/remove 😄 reaction" },
react_confused = { lhs = "<space>rc", desc = "add/remove 😕 reaction" },
react_hooray = { lhs = "<leader>rp", desc = "add/remove 🎉 reaction" },
react_heart = { lhs = "<leader>rh", desc = "add/remove ❤️ reaction" },
react_eyes = { lhs = "<leader>re", desc = "add/remove 👀 reaction" },
react_thumbs_up = { lhs = "<leader>r+", desc = "add/remove 👍 reaction" },
react_thumbs_down = { lhs = "<leader>r-", desc = "add/remove 👎 reaction" },
react_rocket = { lhs = "<leader>rr", desc = "add/remove 🚀 reaction" },
react_laugh = { lhs = "<leader>rl", desc = "add/remove 😄 reaction" },
react_confused = { lhs = "<leader>rc", desc = "add/remove 😕 reaction" },
},
submit_win = {
approve_review = { lhs = "<C-a>", desc = "approve review" },
Expand All @@ -260,8 +260,8 @@ require"octo".setup({
review_diff = {
submit_review = { lhs = "<leader>vs", desc = "submit review" },
discard_review = { lhs = "<leader>vd", desc = "discard review" },
add_review_comment = { lhs = "<space>ca", desc = "add a new review comment" },
add_review_suggestion = { lhs = "<space>sa", desc = "add a new review suggestion" },
add_review_comment = { lhs = "<leader>ca", desc = "add a new review comment" },
add_review_suggestion = { lhs = "<leader>sa", desc = "add a new review suggestion" },
focus_files = { lhs = "<leader>e", desc = "move focus to changed file panel" },
toggle_files = { lhs = "<leader>b", desc = "hide/show changed files panel" },
next_thread = { lhs = "]t", desc = "move to next thread" },
Expand Down Expand Up @@ -442,7 +442,7 @@ Octo search assignee:pwntester is:pr
- Start a review with `Octo review start` or resume a pending review with `Octo review resume`
- A new tab will show a panel with changed files and two windows showing the diff on any of them.
- Change panel entries with `]q` and `[q` or by selecting an entry in the window
- Add comments with `<space>ca` or suggestions with `<space>sa` on single or multiple visual-selected lines
- Add comments with `<leader>ca` or suggestions with `<leader>sa` on single or multiple visual-selected lines
- A new buffer will appear in the alternate diff window. The cursor will be positioned in the new buffer
- When ready, save the buffer to commit changes to GitHub
- Move back to the diff window and move the cursor, the thread buffer will hide
Expand Down
2 changes: 1 addition & 1 deletion doc/octo.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ PR REVIEW *octo-pr-review*
* Start a review with `Octo review start` or resume a pending review with `Octo review resume`
A new tab will show a panel with changed files and two windows showing the diff on any of them.
Change panel entries with `]q` and `[q` or by selecting an entry in the window.
* Add comments with `<space>ca` or suggestions with `<space>sa` on single or
* Add comments with `<leader>ca` or suggestions with `<leader>sa` on single or
multiple visual-selected lines
* A new buffer will appear in the alternate diff window. Cursor will be
positioned in the new buffer
Expand Down
Loading

0 comments on commit 0adcc6d

Please sign in to comment.