Add worktrees view (#2147)

Author: jesseduffield

.gitignore

@@ -39,3 +39,5 @@ test/results/**
 
 oryxBuildBinary
 __debug_bin
+
+.worktrees

docs/Config.md

@@ -323,6 +323,7 @@ os:
   editAtLine: 'myeditor --line={{line}} {{filename}}'
   editAtLineAndWait: 'myeditor --block --line={{line}} {{filename}}'
   editInTerminal: true
+  openDirInEditor: 'myeditor {{dir}}'
 ```
 
 The `editInTerminal` option is used to decide whether lazygit needs to suspend

docs/Custom_Command_Keybindings.md

@@ -74,6 +74,7 @@ The permitted contexts are:
 | -------------- | -------------------------------------------------------------------------------------------------------- |
 | status         | The 'Status' tab                                                                                         |
 | files          | The 'Files' tab                                                                                          |
+| worktrees      | The 'Worktrees' tab                                                                                      |
 | localBranches  | The 'Local Branches' tab                                                                                 |
 | remotes        | The 'Remotes' tab                                                                                        |
 | remoteBranches | The context you get when pressing enter on a remote in the remotes tab                                   |
@@ -300,6 +301,7 @@ SelectedRemote
 SelectedTag
 SelectedStashEntry
 SelectedCommitFile
+SelectedWorktree
 CheckedOutBranch
 ```
 

docs/keybindings/Keybindings_en.md

@@ -89,6 +89,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
   <kbd>t</kbd>: Revert commit
   <kbd>T</kbd>: Tag commit
   <kbd>&lt;c-l&gt;</kbd>: Open log menu
+  <kbd>w</kbd>: View worktree options
   <kbd>&lt;space&gt;</kbd>: Checkout commit
   <kbd>y</kbd>: Copy commit attribute
   <kbd>o</kbd>: Open commit in browser
@@ -154,6 +155,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
   <kbd>g</kbd>: View reset options
   <kbd>R</kbd>: Rename branch
   <kbd>u</kbd>: Set/Unset upstream
+  <kbd>w</kbd>: View worktree options
   <kbd>&lt;enter&gt;</kbd>: View commits
   <kbd>/</kbd>: Filter the current view by text
 </pre>
@@ -231,6 +233,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
 
 <pre>
   <kbd>&lt;c-o&gt;</kbd>: Copy commit SHA to clipboard
+  <kbd>w</kbd>: View worktree options
   <kbd>&lt;space&gt;</kbd>: Checkout commit
   <kbd>y</kbd>: Copy commit attribute
   <kbd>o</kbd>: Open commit in browser
@@ -254,6 +257,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
   <kbd>d</kbd>: Delete branch
   <kbd>u</kbd>: Set as upstream of checked-out branch
   <kbd>g</kbd>: View reset options
+  <kbd>w</kbd>: View worktree options
   <kbd>&lt;enter&gt;</kbd>: View commits
   <kbd>/</kbd>: Filter the current view by text
 </pre>
@@ -276,6 +280,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
   <kbd>d</kbd>: Drop
   <kbd>n</kbd>: New branch
   <kbd>r</kbd>: Rename stash
+  <kbd>w</kbd>: View worktree options
   <kbd>&lt;enter&gt;</kbd>: View selected item's files
   <kbd>/</kbd>: Filter the current view by text
 </pre>
@@ -294,6 +299,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
 
 <pre>
   <kbd>&lt;c-o&gt;</kbd>: Copy commit SHA to clipboard
+  <kbd>w</kbd>: View worktree options
   <kbd>&lt;space&gt;</kbd>: Checkout commit
   <kbd>y</kbd>: Copy commit attribute
   <kbd>o</kbd>: Open commit in browser
@@ -311,6 +317,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
 <pre>
   <kbd>&lt;c-o&gt;</kbd>: Copy submodule name to clipboard
   <kbd>&lt;enter&gt;</kbd>: Enter submodule
+  <kbd>&lt;space&gt;</kbd>: Enter submodule
   <kbd>d</kbd>: Remove submodule
   <kbd>u</kbd>: Update submodule
   <kbd>n</kbd>: Add new submodule
@@ -328,6 +335,18 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
   <kbd>P</kbd>: Push tag
   <kbd>n</kbd>: Create tag
   <kbd>g</kbd>: View reset options
+  <kbd>w</kbd>: View worktree options
   <kbd>&lt;enter&gt;</kbd>: View commits
   <kbd>/</kbd>: Filter the current view by text
 </pre>
+
+## Worktrees
+
+<pre>
+  <kbd>n</kbd>: Create worktree
+  <kbd>&lt;space&gt;</kbd>: Switch to worktree
+  <kbd>&lt;enter&gt;</kbd>: Switch to worktree
+  <kbd>o</kbd>: Open in editor
+  <kbd>d</kbd>: Remove worktree
+  <kbd>/</kbd>: Filter the current view by text
+</pre>

docs/keybindings/Keybindings_ja.md

@@ -52,6 +52,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
   <kbd>d</kbd>: Drop
   <kbd>n</kbd>: 新しいブランチを作成
   <kbd>r</kbd>: Stashを変更
+  <kbd>w</kbd>: View worktree options
   <kbd>&lt;enter&gt;</kbd>: View selected item's files
   <kbd>/</kbd>: Filter the current view by text
 </pre>
@@ -60,6 +61,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
 
 <pre>
   <kbd>&lt;c-o&gt;</kbd>: コミットのSHAをクリップボードにコピー
+  <kbd>w</kbd>: View worktree options
   <kbd>&lt;space&gt;</kbd>: コミットをチェックアウト
   <kbd>y</kbd>: コミットの情報をコピー
   <kbd>o</kbd>: ブラウザでコミットを開く
@@ -72,6 +74,17 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
   <kbd>/</kbd>: 検索を開始
 </pre>
 
+## Worktrees
+
+<pre>
+  <kbd>n</kbd>: Create worktree
+  <kbd>&lt;space&gt;</kbd>: Switch to worktree
+  <kbd>&lt;enter&gt;</kbd>: Switch to worktree
+  <kbd>o</kbd>: Open in editor
+  <kbd>d</kbd>: Remove worktree
+  <kbd>/</kbd>: Filter the current view by text
+</pre>
+
 ## コミット
 
 <pre>
@@ -95,6 +108,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
   <kbd>t</kbd>: コミットをrevert
   <kbd>T</kbd>: タグを作成
   <kbd>&lt;c-l&gt;</kbd>: ログメニューを開く
+  <kbd>w</kbd>: View worktree options
   <kbd>&lt;space&gt;</kbd>: コミットをチェックアウト
   <kbd>y</kbd>: コミットの情報をコピー
   <kbd>o</kbd>: ブラウザでコミットを開く
@@ -133,6 +147,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
 <pre>
   <kbd>&lt;c-o&gt;</kbd>: サブモジュール名をクリップボードにコピー
   <kbd>&lt;enter&gt;</kbd>: サブモジュールを開く
+  <kbd>&lt;space&gt;</kbd>: サブモジュールを開く
   <kbd>d</kbd>: サブモジュールを削除
   <kbd>u</kbd>: サブモジュールを更新
   <kbd>n</kbd>: サブモジュールを新規追加
@@ -160,6 +175,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
   <kbd>P</kbd>: タグをpush
   <kbd>n</kbd>: タグを作成
   <kbd>g</kbd>: View reset options
+  <kbd>w</kbd>: View worktree options
   <kbd>&lt;enter&gt;</kbd>: コミットを閲覧
   <kbd>/</kbd>: Filter the current view by text
 </pre>
@@ -211,6 +227,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
   <kbd>g</kbd>: View reset options
   <kbd>R</kbd>: ブランチ名を変更
   <kbd>u</kbd>: Set/Unset upstream
+  <kbd>w</kbd>: View worktree options
   <kbd>&lt;enter&gt;</kbd>: コミットを閲覧
   <kbd>/</kbd>: Filter the current view by text
 </pre>
@@ -305,6 +322,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
   <kbd>d</kbd>: ブランチを削除
   <kbd>u</kbd>: Set as upstream of checked-out branch
   <kbd>g</kbd>: View reset options
+  <kbd>w</kbd>: View worktree options
   <kbd>&lt;enter&gt;</kbd>: コミットを閲覧
   <kbd>/</kbd>: Filter the current view by text
 </pre>
@@ -313,6 +331,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
 
 <pre>
   <kbd>&lt;c-o&gt;</kbd>: コミットのSHAをクリップボードにコピー
+  <kbd>w</kbd>: View worktree options
   <kbd>&lt;space&gt;</kbd>: コミットをチェックアウト
   <kbd>y</kbd>: コミットの情報をコピー
   <kbd>o</kbd>: ブラウザでコミットを開く

docs/keybindings/Keybindings_ko.md

@@ -48,6 +48,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
 
 <pre>
   <kbd>&lt;c-o&gt;</kbd>: 커밋 SHA를 클립보드에 복사
+  <kbd>w</kbd>: View worktree options
   <kbd>&lt;space&gt;</kbd>: 커밋을 체크아웃
   <kbd>y</kbd>: 커밋 attribute 복사
   <kbd>o</kbd>: 브라우저에서 커밋 열기
@@ -68,6 +69,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
   <kbd>d</kbd>: Drop
   <kbd>n</kbd>: 새 브랜치 생성
   <kbd>r</kbd>: Rename stash
+  <kbd>w</kbd>: View worktree options
   <kbd>&lt;enter&gt;</kbd>: View selected item's files
   <kbd>/</kbd>: Filter the current view by text
 </pre>
@@ -76,6 +78,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
 
 <pre>
   <kbd>&lt;c-o&gt;</kbd>: 커밋 SHA를 클립보드에 복사
+  <kbd>w</kbd>: View worktree options
   <kbd>&lt;space&gt;</kbd>: 커밋을 체크아웃
   <kbd>y</kbd>: 커밋 attribute 복사
   <kbd>o</kbd>: 브라우저에서 커밋 열기
@@ -88,6 +91,17 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
   <kbd>/</kbd>: 검색 시작
 </pre>
 
+## Worktrees
+
+<pre>
+  <kbd>n</kbd>: Create worktree
+  <kbd>&lt;space&gt;</kbd>: Switch to worktree
+  <kbd>&lt;enter&gt;</kbd>: Switch to worktree
+  <kbd>o</kbd>: Open in editor
+  <kbd>d</kbd>: Remove worktree
+  <kbd>/</kbd>: Filter the current view by text
+</pre>
+
 ## 메뉴
 
 <pre>
@@ -177,6 +191,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
   <kbd>g</kbd>: View reset options
   <kbd>R</kbd>: 브랜치 이름 변경
   <kbd>u</kbd>: Set/Unset upstream
+  <kbd>w</kbd>: View worktree options
   <kbd>&lt;enter&gt;</kbd>: 커밋 보기
   <kbd>/</kbd>: Filter the current view by text
 </pre>
@@ -196,6 +211,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
 <pre>
   <kbd>&lt;c-o&gt;</kbd>: 서브모듈 이름을 클립보드에 복사
   <kbd>&lt;enter&gt;</kbd>: 서브모듈 열기
+  <kbd>&lt;space&gt;</kbd>: 서브모듈 열기
   <kbd>d</kbd>: 서브모듈 삭제
   <kbd>u</kbd>: 서브모듈 업데이트
   <kbd>n</kbd>: 새로운 서브모듈 추가
@@ -226,6 +242,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
   <kbd>d</kbd>: 브랜치 삭제
   <kbd>u</kbd>: Set as upstream of checked-out branch
   <kbd>g</kbd>: View reset options
+  <kbd>w</kbd>: View worktree options
   <kbd>&lt;enter&gt;</kbd>: 커밋 보기
   <kbd>/</kbd>: Filter the current view by text
 </pre>
@@ -253,6 +270,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
   <kbd>t</kbd>: 커밋 되돌리기
   <kbd>T</kbd>: Tag commit
   <kbd>&lt;c-l&gt;</kbd>: 로그 메뉴 열기
+  <kbd>w</kbd>: View worktree options
   <kbd>&lt;space&gt;</kbd>: 커밋을 체크아웃
   <kbd>y</kbd>: 커밋 attribute 복사
   <kbd>o</kbd>: 브라우저에서 커밋 열기
@@ -294,6 +312,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
   <kbd>P</kbd>: 태그를 push
   <kbd>n</kbd>: 태그를 생성
   <kbd>g</kbd>: View reset options
+  <kbd>w</kbd>: View worktree options
   <kbd>&lt;enter&gt;</kbd>: 커밋 보기
   <kbd>/</kbd>: Filter the current view by text
 </pre>

docs/keybindings/Keybindings_nl.md

@@ -98,6 +98,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
   <kbd>g</kbd>: Bekijk reset opties
   <kbd>R</kbd>: Hernoem branch
   <kbd>u</kbd>: Set/Unset upstream
+  <kbd>w</kbd>: View worktree options
   <kbd>&lt;enter&gt;</kbd>: Bekijk commits
   <kbd>/</kbd>: Filter the current view by text
 </pre>
@@ -147,6 +148,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
   <kbd>t</kbd>: Commit ongedaan maken
   <kbd>T</kbd>: Tag commit
   <kbd>&lt;c-l&gt;</kbd>: Open log menu
+  <kbd>w</kbd>: View worktree options
   <kbd>&lt;space&gt;</kbd>: Checkout commit
   <kbd>y</kbd>: Copy commit attribute
   <kbd>o</kbd>: Open commit in browser
@@ -209,6 +211,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
 
 <pre>
   <kbd>&lt;c-o&gt;</kbd>: Kopieer commit SHA naar klembord
+  <kbd>w</kbd>: View worktree options
   <kbd>&lt;space&gt;</kbd>: Checkout commit
   <kbd>y</kbd>: Copy commit attribute
   <kbd>o</kbd>: Open commit in browser
@@ -232,6 +235,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
   <kbd>d</kbd>: Verwijder branch
   <kbd>u</kbd>: Stel in als upstream van uitgecheckte branch
   <kbd>g</kbd>: Bekijk reset opties
+  <kbd>w</kbd>: View worktree options
   <kbd>&lt;enter&gt;</kbd>: Bekijk commits
   <kbd>/</kbd>: Filter the current view by text
 </pre>
@@ -276,6 +280,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
   <kbd>d</kbd>: Laten vallen
   <kbd>n</kbd>: Nieuwe branch
   <kbd>r</kbd>: Rename stash
+  <kbd>w</kbd>: View worktree options
   <kbd>&lt;enter&gt;</kbd>: Bekijk gecommite bestanden
   <kbd>/</kbd>: Filter the current view by text
 </pre>
@@ -294,6 +299,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
 
 <pre>
   <kbd>&lt;c-o&gt;</kbd>: Kopieer commit SHA naar klembord
+  <kbd>w</kbd>: View worktree options
   <kbd>&lt;space&gt;</kbd>: Checkout commit
   <kbd>y</kbd>: Copy commit attribute
   <kbd>o</kbd>: Open commit in browser
@@ -311,6 +317,7 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
 <pre>
   <kbd>&lt;c-o&gt;</kbd>: Kopieer submodule naam naar klembord
   <kbd>&lt;enter&gt;</kbd>: Enter submodule
+  <kbd>&lt;space&gt;</kbd>: Enter submodule
   <kbd>d</kbd>: Remove submodule
   <kbd>u</kbd>: Update submodule
   <kbd>n</kbd>: Voeg nieuwe submodule toe
@@ -328,6 +335,18 @@ _Legend: `<c-b>` means ctrl+b, `<a-b>` means alt+b, `B` means shift+b_
   <kbd>P</kbd>: Push tag
   <kbd>n</kbd>: Creëer tag
   <kbd>g</kbd>: Bekijk reset opties
+  <kbd>w</kbd>: View worktree options
   <kbd>&lt;enter&gt;</kbd>: Bekijk commits
   <kbd>/</kbd>: Filter the current view by text
 </pre>
+
+## Worktrees
+
+<pre>
+  <kbd>n</kbd>: Create worktree
+  <kbd>&lt;space&gt;</kbd>: Switch to worktree
+  <kbd>&lt;enter&gt;</kbd>: Switch to worktree
+  <kbd>o</kbd>: Open in editor
+  <kbd>d</kbd>: Remove worktree
+  <kbd>/</kbd>: Filter the current view by text
+</pre>