feat(sidebar): show worktrees under their repository

Add an opt-in sidebar mode that lists linked worktrees beneath their main repository so repository switching can stay in the main sidebar instead of requiring the worktree dropdown.

Changes:
- add a secondary appearance setting to show worktrees in the repository sidebar when worktree support is enabled
- group linked worktrees under their main repository and synthesize sidebar rows for worktrees that are not already stored as repositories
- render nested rows with the worktree folder name, keep alias styling behavior unchanged, and avoid duplicate pull-all work for linked worktrees
- persist sidebar worktree metadata in repository state and expose main worktree path helpers needed for grouping
- add unit coverage for grouped and synthetic worktree rows and throttle sidebar worktree refreshes to reduce repeated git worktree list churn during indicator updates

Testing:
- yarn test:unit app/test/unit/repositories-list-grouping-test.ts
- yarn eslint app/src/lib/stores/app-store.ts app/src/ui/repositories-list/group-repositories.ts app/src/ui/repositories-list/repositories-list.tsx app/src/ui/repositories-list/repository-list-item.tsx app/src/ui/preferences/appearance.tsx app/src/ui/preferences/preferences.tsx app/src/lib/git/worktree.ts app/src/models/repository.ts app/src/lib/app-state.ts app/src/ui/app.tsx app/src/ui/dispatcher/dispatcher.ts app/test/unit/repositories-list-grouping-test.ts
- yarn compile:dev

Author: ignatremizov

app/src/lib/app-state.ts

@@ -320,6 +320,9 @@ export interface IAppState {
   /** Whether or not the worktrees dropdown should be shown in the toolbar */
   readonly showWorktrees: boolean
 
+  /** Whether linked worktrees should be shown under their repository in the sidebar */
+  readonly showWorktreesInSidebar: boolean
+
   /** Whether or not the Compare tab should be shown in the repository view */
   readonly showCompareTab: boolean
 

app/src/lib/git/worktree.ts

@@ -5,6 +5,36 @@ import type { WorktreeEntry, WorktreeType } from '../../models/worktree'
 import { git } from './core'
 import { normalizePath } from '../helpers/path'
 
+function getDotGitPath(repositoryPath: string): string {
+  return Path.join(repositoryPath, '.git')
+}
+
+function getGitDirPathSync(repositoryPath: string): string | null {
+  const dotGit = getDotGitPath(repositoryPath)
+
+  try {
+    // eslint-disable-next-line no-sync
+    const stats = Fs.statSync(dotGit)
+    if (stats.isDirectory()) {
+      return dotGit
+    }
+
+    if (!stats.isFile()) {
+      return null
+    }
+
+    // eslint-disable-next-line no-sync
+    const contents = Fs.readFileSync(dotGit, 'utf8').trim()
+    if (!contents.startsWith('gitdir: ')) {
+      return null
+    }
+
+    return Path.resolve(repositoryPath, contents.substring('gitdir: '.length))
+  } catch {
+    return null
+  }
+}
+
 export function parseWorktreePorcelainOutput(
   stdout: string
 ): ReadonlyArray<WorktreeEntry> {
@@ -141,11 +171,36 @@ export async function getMainWorktreePath(
  */
 export function isLinkedWorktreeSync(repositoryPath: string): boolean {
   try {
-    const dotGit = Path.join(repositoryPath, '.git')
+    const dotGit = getDotGitPath(repositoryPath)
     // eslint-disable-next-line no-sync
     const stats = Fs.statSync(dotGit)
     return stats.isFile()
   } catch {
     return false
   }
 }
+
+export function getMainWorktreePathSync(repositoryPath: string): string | null {
+  const gitDirPath = getGitDirPathSync(repositoryPath)
+  if (gitDirPath === null) {
+    return null
+  }
+
+  if (!isLinkedWorktreeSync(repositoryPath)) {
+    return repositoryPath
+  }
+
+  try {
+    // eslint-disable-next-line no-sync
+    const commondir = Fs.readFileSync(Path.join(gitDirPath, 'commondir'), 'utf8')
+      .trim()
+    if (commondir.length === 0) {
+      return null
+    }
+
+    const commonGitDir = Path.resolve(gitDirPath, commondir)
+    return Path.dirname(commonGitDir)
+  } catch {
+    return null
+  }
+}

app/src/lib/stores/app-store.ts

@@ -467,10 +467,17 @@ const shellKey = 'shell'
 
 const showRecentRepositoriesKey = 'show-recent-repositories'
 const showWorktreesKey = 'show-worktrees'
+const showWorktreesInSidebarKey = 'show-worktrees-in-sidebar'
 const showCompareTabKey = 'show-compare-tab'
 const showCompareTabDefault = true
 const repositoryIndicatorsEnabledKey = 'enable-repository-indicators'
 
+/**
+ * Refresh sidebar worktree metadata more sparingly than the repository
+ * indicator loop to avoid repeatedly shelling out to `git worktree list`.
+ */
+const SidebarWorktreeRefreshInterval = 2 * 60 * 1000
+
 // background fetching should occur hourly when Desktop is active, but this
 // lower interval ensures user interactions like switching repositories and
 // switching between apps does not result in excessive fetching in the app
@@ -636,6 +643,8 @@ export class AppStore extends TypedBaseStore<IAppState> {
   private titleBarStyle: TitleBarStyle = 'native'
   private showRecentRepositories: boolean = true
   private showWorktrees: boolean = false
+  private showWorktreesInSidebar: boolean = false
+  private readonly lastSidebarWorktreeRefreshAt = new Map<string, number>()
   private showCompareTab: boolean = showCompareTabDefault
   private hideWindowOnQuit: boolean = __DARWIN__
 
@@ -754,6 +763,9 @@ export class AppStore extends TypedBaseStore<IAppState> {
 
     this.showRecentRepositories = getBoolean(showRecentRepositoriesKey) ?? true
     this.showWorktrees = getBoolean(showWorktreesKey) ?? false
+    this.showWorktreesInSidebar =
+      this.showWorktrees &&
+      (getBoolean(showWorktreesInSidebarKey) ?? false)
     this.showCompareTab = getBoolean(showCompareTabKey, showCompareTabDefault)
 
     this.repositoryIndicatorUpdater = new RepositoryIndicatorUpdater(
@@ -1207,6 +1219,7 @@ export class AppStore extends TypedBaseStore<IAppState> {
       titleBarStyle: this.titleBarStyle,
       showRecentRepositories: this.showRecentRepositories,
       showWorktrees: this.showWorktrees,
+      showWorktreesInSidebar: this.showWorktreesInSidebar,
       showCompareTab: this.showCompareTab,
       apiRepositories: this.apiRepositoriesStore.getState(),
       useWindowsOpenSSH: this.useWindowsOpenSSH,
@@ -4057,6 +4070,9 @@ export class AppStore extends TypedBaseStore<IAppState> {
       changedFilesCount: status.workingDirectory.files.length,
       branchName: status.currentBranch || null,
       defaultBranchName: repository.defaultBranch,
+      allWorktrees: this.showWorktreesInSidebar
+        ? this.repositoryStateCache.get(repository).worktreesState.allWorktrees
+        : [],
     })
   }
   /**
@@ -4083,6 +4099,19 @@ export class AppStore extends TypedBaseStore<IAppState> {
       return
     }
 
+    if (
+      this.showWorktreesInSidebar &&
+      !repository.isLinkedWorktree &&
+      this.shouldRefreshSidebarWorktrees(repository)
+    ) {
+      await gitStore.loadWorktrees()
+      this.repositoryStateCache.updateWorktreesState(repository, () => ({
+        allWorktrees: gitStore.allWorktrees,
+        currentWorktree: gitStore.currentWorktree,
+      }))
+      this.lastSidebarWorktreeRefreshAt.set(repository.hash, Date.now())
+    }
+
     this.updateSidebarIndicator(repository, status)
     this.emitUpdate()
 
@@ -4104,11 +4133,26 @@ export class AppStore extends TypedBaseStore<IAppState> {
         changedFilesCount: existing?.changedFilesCount ?? 0,
         branchName: existing?.branchName ?? null,
         defaultBranchName: existing?.defaultBranchName ?? null,
+        allWorktrees: existing?.allWorktrees ?? [],
       })
       this.emitUpdate()
     }
   }
 
+  private shouldRefreshSidebarWorktrees(repository: Repository) {
+    const lastRefreshedAt =
+      this.lastSidebarWorktreeRefreshAt.get(repository.hash) ?? 0
+
+    if (Date.now() - lastRefreshedAt >= SidebarWorktreeRefreshInterval) {
+      return true
+    }
+
+    const cachedWorktrees =
+      this.repositoryStateCache.get(repository).worktreesState.allWorktrees
+
+    return cachedWorktrees.length === 0
+  }
+
   private getRepositoriesForIndicatorRefresh = () => {
     // The currently selected repository will get refreshed by both the
     // BackgroundFetcher and the refreshRepository call from the
@@ -4178,10 +4222,30 @@ export class AppStore extends TypedBaseStore<IAppState> {
     }
     setBoolean(showWorktreesKey, showWorktrees)
     this.showWorktrees = showWorktrees
+    if (!showWorktrees && this.showWorktreesInSidebar) {
+      setBoolean(showWorktreesInSidebarKey, false)
+      this.showWorktreesInSidebar = false
+      this.lastSidebarWorktreeRefreshAt.clear()
+    }
     this.updateResizableConstraints()
     this.emitUpdate()
   }
 
+  public _setShowWorktreesInSidebar(showWorktreesInSidebar: boolean) {
+    if (this.showWorktreesInSidebar === showWorktreesInSidebar) {
+      return
+    }
+
+    if (showWorktreesInSidebar && !this.showWorktrees) {
+      return
+    }
+
+    setBoolean(showWorktreesInSidebarKey, showWorktreesInSidebar)
+    this.showWorktreesInSidebar = showWorktreesInSidebar
+    this.lastSidebarWorktreeRefreshAt.clear()
+    this.emitUpdate()
+  }
+
   public _setShowCompareTab(showCompareTab: boolean) {
     if (this.showCompareTab === showCompareTab) {
       return

app/src/models/repository.ts

@@ -2,13 +2,17 @@ import * as Path from 'path'
 
 import { GitHubRepository, ForkedGitHubRepository } from './github-repository'
 import { IAheadBehind } from './branch'
+import { WorktreeEntry } from './worktree'
 import {
   WorkflowPreferences,
   ForkContributionTarget,
 } from './workflow-preferences'
 import { assertNever, fatalError } from '../lib/fatal-error'
 import { createEqualityHash } from './equality-hash'
-import { isLinkedWorktreeSync } from '../lib/git/worktree'
+import {
+  isLinkedWorktreeSync,
+  getMainWorktreePathSync,
+} from '../lib/git/worktree'
 import { getRemotes } from '../lib/git'
 import { findDefaultRemote } from '../lib/stores/helpers/find-default-remote'
 import { isTrustedRemoteHost } from '../lib/api'
@@ -57,6 +61,7 @@ export class Repository {
   private _url: string | null = null
 
   private _isLinkedWorktree: boolean | undefined = undefined
+  private _mainWorktreePath: string | undefined = undefined
 
   /**
    * @param path The working directory of this repository
@@ -109,6 +114,14 @@ export class Repository {
     return this._isLinkedWorktree
   }
 
+  public get mainWorktreePath(): string {
+    if (this._mainWorktreePath === undefined) {
+      this._mainWorktreePath = getMainWorktreePathSync(this.path) ?? this.path
+    }
+
+    return this._mainWorktreePath
+  }
+
   public get url(): string | null {
     // Resolve the default remote URL if not yet done.
     if (this._url === null) {
@@ -229,6 +242,10 @@ export interface ILocalRepositoryState {
    * The name of the default branch, or `undefined` if not available.
    */
   readonly defaultBranchName: string | null
+  /**
+   * All worktrees known for this repository.
+   */
+  readonly allWorktrees: ReadonlyArray<WorktreeEntry>
 }
 
 /**

app/src/ui/app.tsx

@@ -1686,6 +1686,7 @@ export class App extends React.Component<IAppProps, IAppState> {
             titleBarStyle={this.state.titleBarStyle}
             showRecentRepositories={this.state.showRecentRepositories}
             showWorktrees={this.state.showWorktrees}
+            showWorktreesInSidebar={this.state.showWorktreesInSidebar}
             showCompareTab={this.state.showCompareTab}
             repositoryIndicatorsEnabled={this.state.repositoryIndicatorsEnabled}
             hideWindowOnQuit={this.state.hideWindowOnQuit}
@@ -3067,9 +3068,11 @@ export class App extends React.Component<IAppProps, IAppState> {
 
     const { useCustomShell, selectedShell } = this.state
     const filterText = this.state.repositoryFilterText
-    const repositories = this.state.repositories.filter(
-      r => !(r instanceof Repository && r.isLinkedWorktree)
-    )
+    const repositories = this.state.showWorktreesInSidebar
+      ? this.state.repositories
+      : this.state.repositories.filter(
+          r => !(r instanceof Repository && r.isLinkedWorktree)
+        )
     return (
       <RepositoriesList
         filterText={filterText}
@@ -3093,6 +3096,7 @@ export class App extends React.Component<IAppProps, IAppState> {
         shellLabel={useCustomShell ? undefined : selectedShell}
         dispatcher={this.props.dispatcher}
         showBranchNameInRepoList={this.state.showBranchNameInRepoList}
+        showWorktreesInSidebar={this.state.showWorktreesInSidebar}
       />
     )
   }

app/src/ui/dispatcher/dispatcher.ts

@@ -2928,6 +2928,10 @@ export class Dispatcher {
     this.appStore._setShowWorktrees(showWorktrees)
   }
 
+  public setShowWorktreesInSidebar(showWorktreesInSidebar: boolean) {
+    this.appStore._setShowWorktreesInSidebar(showWorktreesInSidebar)
+  }
+
   public setShowCompareTab(showCompareTab: boolean) {
     this.appStore._setShowCompareTab(showCompareTab)
   }

app/src/ui/preferences/appearance.tsx

@@ -29,6 +29,8 @@ interface IAppearanceProps {
   readonly onShowRecentRepositoriesChanged: (show: boolean) => void
   readonly showWorktrees: boolean
   readonly onShowWorktreesChanged: (show: boolean) => void
+  readonly showWorktreesInSidebar: boolean
+  readonly onShowWorktreesInSidebarChanged: (show: boolean) => void
   readonly showCompareTab: boolean
   readonly onShowCompareTabChanged: (show: boolean) => void
   readonly showBranchNameInRepoList: ShowBranchNameInRepoListSetting
@@ -47,6 +49,7 @@ interface IAppearanceState {
   readonly titleBarStyle: TitleBarStyle
   readonly showRecentRepositories: boolean
   readonly showWorktrees: boolean
+  readonly showWorktreesInSidebar: boolean
   readonly showCompareTab: boolean
 }
 
@@ -76,6 +79,7 @@ export class Appearance extends React.Component<
       titleBarStyle: props.titleBarStyle,
       showRecentRepositories: props.showRecentRepositories,
       showWorktrees: props.showWorktrees,
+      showWorktreesInSidebar: props.showWorktreesInSidebar,
       showCompareTab: props.showCompareTab,
     }
 
@@ -136,6 +140,14 @@ export class Appearance extends React.Component<
     this.props.onShowCompareTabChanged(show)
   }
 
+  private onShowWorktreesInSidebarChanged = (
+    event: React.FormEvent<HTMLInputElement>
+  ) => {
+    const show = event.currentTarget.checked
+    this.setState({ showWorktreesInSidebar: show })
+    this.props.onShowWorktreesInSidebarChanged(show)
+  }
+
   private onSelectedTabSizeChanged = (
     event: React.FormEvent<HTMLSelectElement>
   ) => {
@@ -363,6 +375,17 @@ export class Appearance extends React.Component<
             }
             onChange={this.onShowWorktreesChanged}
           />
+          {this.state.showWorktrees && (
+            <Checkbox
+              label="Show worktrees in repository sidebar"
+              value={
+                this.state.showWorktreesInSidebar
+                  ? CheckboxValue.On
+                  : CheckboxValue.Off
+              }
+              onChange={this.onShowWorktreesInSidebarChanged}
+            />
+          )}
         </div>
         <div className="advanced-section">
           <h2>{'Commit list'}</h2>