This repository was archived by the owner on Dec 15, 2022. It is now read-only.
Repository navigation
This repository was archived by the owner on Dec 15, 2022. It is now read-only.
Keyboard interactions for Git committing #174
Description
Before we staff ship, it should be possible to commit via this package without ever touching the mouse. Here's some initial thinking I did with @maxbrunsfeld on a comprehensive keybinding scheme.
- Focusing and toggling the Git and GitHub panels. These bindings are based on a logical extension of the existing binding for toggling focus on the tree view. Since they're based on numbers, we could potentially extend this scheme even further to manage other panels:
- Existing binding
ctrl-0– focus/blur the tree view
- Proposed new bindings:
ctrl-shift-0– show/hide the tree viewctrl-9– focus/blur the Git panelctrl-shift-9– show/hide the Git panelctrl-8– focus/blur the GitHub panel ("8" for "Octocat")ctrl-shift-8– show/hide the GitHub panelescblurs the panel, returning focus to the active pane item
- Existing binding
- Moving focus between elements of the Git panel. When you focus the Git panel, either the unstaged/staged file list is focused or the commit message editor is focused.
- "Sub-focus" is retained across panel focus/blur events, so you could blur the panel with the commit message editor focused, then still have the editor focused when you restore focus to the panel.
tabmoves forward between merge conflicts, unstaged files, staged files and finally to the commit message editor. Once focus is in the editor, we do not change focus ontabbut instead insert tabs / spaces into the editor. To return to the lists, useshift-tab.shift-tabmoves backward from the commit message editor to the staged files, unstaged files, and finally merge conflicts. To match behavior of tab going forward, we don't cycle around.- Intuitive arrow navigation
downon the last entry in the file list focuses the commit editor.upat position(0, 0)of the editor moves to the last item of the file list.
- Navigating unstaged/staged files
upanddownnavigate both unstaged and staged file lists as a single list.lefttransfers focus from the panel to the currently selected diffrighttransfers focus to the current diff back to the panelentertoggles staging status on the selected file and selects the next item in the list.
- Committing
cmd-enter(ctrl-enteron Win/Linux) anywhere in the git panel with a non-empty commit message creates a commit.cmd-enterwith an empty commit message focuses the commit editor.
/cc @atom/core
Metadata
Metadata
Assignees
Labels
No labels
Activity
simurai commentedon Jul 12, 2016
How about a "stage all" shortcut so you don't have to stage files one by one (still need a button for that as well).
shift-entertoggles staging status on all files in a list. Basically moves all files between unstaged/stages changes.And maybe combined with commiting.
cmd-shift-enter(ctrl-enter on Win/Linux) anywhere in the git panel with a non-empty commit message stages all files and creates a commit.cmd-shift-enterwith an empty commit message stages all files and focuses the commit editor.[-]Keyboard interactions for Git comitting[/-][+]Keyboard interactions for Git committing[/+]nathansobo commentedon Jul 12, 2016
Adjusted the specification for
tabandshift-tabin the Git panel to visit each list after having second thoughts about unifying them.smashwilson commentedon Dec 12, 2016
I've started this off in #363, with a few minor differences from the description above:
(unstaged, merge conflicts, staged, commit editor)to be consistent.rightreturns focus to the git panel from a FilePatchView, I'm thinking it should focus the corresponding entry in the file lists rather than preserving the last focus. Would that feel right to you?nathansobo commentedon Dec 13, 2016
Your adjustments seem very reasonable. 👍🏻
smashwilson commentedon Dec 14, 2016
I'd like to defer two of these tasks to new PRs.
This one because I suspect it'll be much easier with #370:
cmd-enter/ctrl-enter👉git:commit👉 With an empty commit message, focuses the commit editor. With a non-empty commit message, creates a commit.And this one because it'd muddy up the diff and collide with pretty much any other changes:
git:commands to be uniformlygithub:commands.simurai commentedon Dec 15, 2016
Started a PR that renames all the class names: #372. Not sure if you wanna join there or start a separate one. So far I only changed the class names of the keybindings, but not the commands.
smashwilson commentedon Dec 15, 2016
@simurai Cool, thanks! Yah, I'll do the rename on your branch 😄
re-syz commentedon Sep 21, 2018
I would like to ask is there any keybinding to stage all, or can I create one?
I've tried this but no react at all.
Thanks!
tassosblackg commentedon Oct 8, 2020
Hi,
is there a way to focus inside git-tab without using the mouse?
I mean when I hit
and git tab toggles I want to focus on the changes box in order to select file with up-down hit enter and then with tab use the commit message etc. I use shortcuts to commit, push fetch etc but