Allow normalizing paths on copy

Author: pol-rivero

app/src/lib/app-state.ts

@@ -41,6 +41,7 @@ import { IStashEntry } from '../models/stash-entry'
 import { TutorialStep } from '../models/tutorial-step'
 import { UncommittedChangesStrategy } from '../models/uncommitted-changes-strategy'
 import { ShowBranchNameInRepoListSetting } from '../models/show-branch-name-in-repo-list'
+import { CopyPathNormalization } from '../models/copy-path-normalization'
 import { BranchSortOrder } from '../models/branch-sort-order'
 import { CommitDateDisplay } from '../models/commit-date-display'
 import { DragElement } from '../models/drag-drop'
@@ -403,6 +404,9 @@ export interface IAppState {
   /** Controls when to show the current branch name next to each repository in the repository list */
   readonly showBranchNameInRepoList: ShowBranchNameInRepoListSetting
 
+  /** Controls slash normalization applied when copying paths to the clipboard */
+  readonly copyPathNormalization: CopyPathNormalization
+
   /** Controls the sort order for branch lists in branch-selection views */
   readonly branchSortOrder: BranchSortOrder
 

app/src/lib/helpers/path.ts

@@ -1,5 +1,21 @@
+import { CopyPathNormalization } from '../../models/copy-path-normalization'
+
 export function normalizePath(path: string): string {
   // Git expects forward slashes, even on Windows.
   // Also trim trailing slashes
   return path.replace(/\\/g, '/').replace(/\/+$/, '')
 }
+
+export function convertToCopyPath(
+  path: string,
+  normalization: CopyPathNormalization
+): string {
+  switch (normalization) {
+    case CopyPathNormalization.Unix:
+      return path.replace(/\\/g, '/')
+    case CopyPathNormalization.Windows:
+      return path.replace(/\//g, '\\')
+    case CopyPathNormalization.None:
+      return path
+  }
+}

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

@@ -182,6 +182,10 @@ import {
   defaultShowBranchNameInRepoListSetting,
   ShowBranchNameInRepoListSetting,
 } from '../../models/show-branch-name-in-repo-list'
+import {
+  CopyPathNormalization,
+  defaultCopyPathNormalization,
+} from '../../models/copy-path-normalization'
 import {
   BranchSortOrder,
   DEFAULT_BRANCH_SORT_ORDER,
@@ -504,6 +508,7 @@ export const showDiffCheckMarksDefault = true
 export const showDiffCheckMarksKey = 'diff-check-marks-visible'
 
 export const showBranchNameInRepoListKey = 'show-branch-name-in-repo-list'
+const copyPathNormalizationKey = 'copy-path-normalization'
 const branchSortOrderKey = 'branch-sort-order'
 const commitDateDisplayKey = 'commit-date-display'
 
@@ -676,6 +681,9 @@ export class AppStore extends TypedBaseStore<IAppState> {
   private showBranchNameInRepoList: ShowBranchNameInRepoListSetting =
     defaultShowBranchNameInRepoListSetting
 
+  private copyPathNormalization: CopyPathNormalization =
+    defaultCopyPathNormalization
+
   private branchSortOrder: BranchSortOrder = DEFAULT_BRANCH_SORT_ORDER
 
   private commitDateDisplay: CommitDateDisplay = defaultCommitDateDisplay
@@ -1231,6 +1239,7 @@ export class AppStore extends TypedBaseStore<IAppState> {
       underlineLinks: this.underlineLinks,
       showDiffCheckMarks: this.showDiffCheckMarks,
       showBranchNameInRepoList: this.showBranchNameInRepoList,
+      copyPathNormalization: this.copyPathNormalization,
       branchSortOrder: this.branchSortOrder,
       commitDateDisplay: this.commitDateDisplay,
       updateState: updateStore.state,
@@ -2643,6 +2652,10 @@ export class AppStore extends TypedBaseStore<IAppState> {
       getEnum(showBranchNameInRepoListKey, ShowBranchNameInRepoListSetting) ??
       defaultShowBranchNameInRepoListSetting
 
+    this.copyPathNormalization =
+      getEnum(copyPathNormalizationKey, CopyPathNormalization) ??
+      defaultCopyPathNormalization
+
     this.branchSortOrder =
       getEnum(branchSortOrderKey, BranchSortOrder) ?? DEFAULT_BRANCH_SORT_ORDER
 
@@ -9253,6 +9266,14 @@ export class AppStore extends TypedBaseStore<IAppState> {
     }
   }
 
+  public _setCopyPathNormalization(value: CopyPathNormalization) {
+    if (value !== this.copyPathNormalization) {
+      this.copyPathNormalization = value
+      localStorage.setItem(copyPathNormalizationKey, value)
+      this.emitUpdate()
+    }
+  }
+
   public _updateBranchSortOrder(branchSortOrder: BranchSortOrder) {
     if (branchSortOrder !== this.branchSortOrder) {
       this.branchSortOrder = branchSortOrder

app/src/models/copy-path-normalization.ts

@@ -0,0 +1,7 @@
+export enum CopyPathNormalization {
+  None = 'None',
+  Unix = 'Unix',
+  Windows = 'Windows',
+}
+
+export const defaultCopyPathNormalization = CopyPathNormalization.None

app/src/ui/app.tsx

@@ -1697,6 +1697,7 @@ export class App extends React.Component<IAppProps, IAppState> {
             showBranchNameInRepoList={this.state.showBranchNameInRepoList}
             branchSortOrder={this.state.branchSortOrder}
             commitDateDisplay={this.state.commitDateDisplay}
+            copyPathNormalization={this.state.copyPathNormalization}
           />
         )
       case PopupType.RepositorySettings: {
@@ -3327,6 +3328,7 @@ export class App extends React.Component<IAppProps, IAppState> {
       shellLabel: this.state.useCustomShell
         ? undefined
         : this.state.selectedShell,
+      onCopyRepoPath: path => this.props.dispatcher.copyPathToClipboard(path),
     })
 
     showContextualMenu(items)

app/src/ui/changes/filter-changes-list.tsx

@@ -36,7 +36,6 @@ import { ChangedFile } from './changed-file'
 import { IAutocompletionProvider } from '../autocompletion'
 import { showContextualMenu } from '../../lib/menu-item'
 import { arrayEquals } from '../../lib/equality'
-import { clipboard } from 'electron'
 import { basename } from 'path'
 import { Commit, ICommitContext } from '../../models/commit'
 import {
@@ -53,7 +52,6 @@ import { hasWritePermission } from '../../models/github-repository'
 import { hasConflictedFiles } from '../../lib/status'
 import { createObservableRef } from '../lib/observable-ref'
 import { Popup, PopupType } from '../../models/popup'
-import { EOL } from 'os'
 import { RepoRulesInfo } from '../../models/repo-rules'
 import { IAheadBehind } from '../../models/branch'
 import { StashDiffViewerId } from '../stashing'
@@ -656,7 +654,7 @@ export class FilterChangesList extends React.Component<
       label: CopyFilePathLabel,
       action: () => {
         const fullPath = Path.join(this.props.repository.path, file.path)
-        clipboard.writeText(fullPath)
+        this.props.dispatcher.copyPathToClipboard(fullPath)
       },
     }
   }
@@ -666,7 +664,8 @@ export class FilterChangesList extends React.Component<
   ): IMenuItem => {
     return {
       label: CopyRelativeFilePathLabel,
-      action: () => clipboard.writeText(Path.normalize(file.path)),
+      action: () =>
+        this.props.dispatcher.copyPathToClipboard(Path.normalize(file.path)),
     }
   }
 
@@ -679,7 +678,7 @@ export class FilterChangesList extends React.Component<
         const fullPaths = files.map(file =>
           Path.join(this.props.repository.path, file.path)
         )
-        clipboard.writeText(fullPaths.join(EOL))
+        this.props.dispatcher.copyPathsToClipboard(fullPaths)
       },
     }
   }
@@ -691,7 +690,7 @@ export class FilterChangesList extends React.Component<
       label: CopySelectedRelativePathsLabel,
       action: () => {
         const paths = files.map(file => Path.normalize(file.path))
-        clipboard.writeText(paths.join(EOL))
+        this.props.dispatcher.copyPathsToClipboard(paths)
       },
     }
   }

app/src/ui/dispatcher/dispatcher.ts

@@ -1,4 +1,5 @@
 import { Disposable, DisposableLike } from 'event-kit'
+import { clipboard } from 'electron'
 
 import {
   IAPIOrganization,
@@ -106,6 +107,7 @@ import { UncommittedChangesStrategy } from '../../models/uncommitted-changes-str
 import { BranchSortOrder } from '../../models/branch-sort-order'
 import { ShowBranchNameInRepoListSetting } from '../../models/show-branch-name-in-repo-list'
 import { CommitDateDisplay } from '../../models/commit-date-display'
+import { CopyPathNormalization } from '../../models/copy-path-normalization'
 import { IStashEntry } from '../../models/stash-entry'
 import { WorkflowPreferences } from '../../models/workflow-preferences'
 import { resolveWithin } from '../../lib/path'
@@ -133,6 +135,8 @@ import { CLIAction } from '../../lib/cli-action'
 import { IBranchNamePreset } from '../../models/branch-preset'
 import { BypassReasonType } from '../secret-scanning/bypass-push-protection-dialog'
 import { EditorOverride } from '../../models/editor-override'
+import { convertToCopyPath } from '../../lib/helpers/path'
+import { EOL } from 'os'
 
 /**
  * An error handler function.
@@ -4213,6 +4217,24 @@ export class Dispatcher {
     )
   }
 
+  public setCopyPathNormalization(value: CopyPathNormalization) {
+    return this.appStore._setCopyPathNormalization(value)
+  }
+
+  public copyPathToClipboard(path: string) {
+    this.copyPathsToClipboard([path])
+  }
+
+  public copyPathsToClipboard(paths: ReadonlyArray<string>) {
+    clipboard.writeText(
+      paths
+        .map(p =>
+          convertToCopyPath(p, this.appStore.getState().copyPathNormalization)
+        )
+        .join(EOL)
+    )
+  }
+
   public setBranchSortOrder(branchSortOrder: BranchSortOrder) {
     return this.appStore._updateBranchSortOrder(branchSortOrder)
   }

app/src/ui/history/selected-commits.tsx

@@ -1,5 +1,4 @@
 import * as React from 'react'
-import { clipboard } from 'electron'
 import * as Path from 'path'
 
 import { Repository } from '../../models/repository'
@@ -21,7 +20,6 @@ import {
   RevealInFileManagerLabel,
   OpenWithDefaultProgramLabel,
 } from '../lib/context-menu'
-import { EOL } from 'os'
 import { ThrottledScheduler } from '../lib/throttled-scheduler'
 
 import { Dispatcher } from '../dispatcher'
@@ -422,28 +420,29 @@ export class SelectedCommits extends React.Component<
         ? [
             {
               label: CopyFilePathLabel,
-              action: () => clipboard.writeText(fullPath),
+              action: () => this.props.dispatcher.copyPathToClipboard(fullPath),
             },
             {
               label: CopyRelativeFilePathLabel,
-              action: () => clipboard.writeText(Path.normalize(file.path)),
+              action: () =>
+                this.props.dispatcher.copyPathToClipboard(
+                  Path.normalize(file.path)
+                ),
             },
           ]
         : [
             {
               label: CopySelectedPathsLabel,
               action: () =>
-                clipboard.writeText(
-                  filesToCopy
-                    .map(f => Path.join(repository.path, f.path))
-                    .join(EOL)
+                this.props.dispatcher.copyPathsToClipboard(
+                  filesToCopy.map(f => Path.join(repository.path, f.path))
                 ),
             },
             {
               label: CopySelectedRelativePathsLabel,
               action: () =>
-                clipboard.writeText(
-                  filesToCopy.map(f => Path.normalize(f.path)).join(EOL)
+                this.props.dispatcher.copyPathsToClipboard(
+                  filesToCopy.map(f => Path.normalize(f.path))
                 ),
             },
           ]

app/src/ui/preferences/integrations.tsx

@@ -8,6 +8,10 @@ import { suggestedExternalEditor } from '../../lib/editors/shared'
 import { CustomIntegrationForm } from './custom-integration-form'
 import { ICustomIntegration } from '../../lib/custom-integration'
 import { enableCustomIntegration } from '../../lib/feature-flag'
+import {
+  CopyPathNormalization,
+  defaultCopyPathNormalization,
+} from '../../models/copy-path-normalization'
 
 const CustomIntegrationValue = 'other'
 
@@ -33,6 +37,10 @@ interface IIntegrationsPreferencesProps {
   readonly onBranchPresetScriptChanged: (
     branchPresetScript: ICustomIntegration
   ) => void
+  readonly copyPathNormalization: CopyPathNormalization
+  readonly onCopyPathNormalizationChanged: (
+    value: CopyPathNormalization
+  ) => void
 }
 
 interface IIntegrationsPreferencesState {
@@ -43,6 +51,7 @@ interface IIntegrationsPreferencesState {
   readonly useCustomShell: boolean
   readonly customShell: ICustomIntegration
   readonly branchPresetScript: ICustomIntegration
+  readonly copyPathNormalization: CopyPathNormalization
 }
 
 export class Integrations extends React.Component<
@@ -63,6 +72,8 @@ export class Integrations extends React.Component<
       useCustomShell: this.props.useCustomShell,
       customShell: this.props.customShell,
       branchPresetScript: this.props.branchPresetScript,
+      copyPathNormalization:
+        this.props.copyPathNormalization ?? defaultCopyPathNormalization,
     }
   }
 
@@ -395,13 +406,38 @@ export class Integrations extends React.Component<
     this.props.onBranchPresetScriptChanged(branchPresetScript)
   }
 
+  private onCopyPathNormalizationChanged = (
+    event: React.FormEvent<HTMLSelectElement>
+  ) => {
+    const value = event.currentTarget.value as CopyPathNormalization
+    this.setState({ copyPathNormalization: value })
+    this.props.onCopyPathNormalizationChanged(value)
+  }
+
+  private renderCopyPathNormalization() {
+    return (
+      <Select
+        label="Normalize copied paths"
+        value={this.state.copyPathNormalization}
+        onChange={this.onCopyPathNormalizationChanged}
+      >
+        <option value={CopyPathNormalization.None}>{"Don't normalize"}</option>
+        <option value={CopyPathNormalization.Unix}>Convert to UNIX (/)</option>
+        <option value={CopyPathNormalization.Windows}>
+          Convert to Windows (\)
+        </option>
+      </Select>
+    )
+  }
+
   public render() {
     if (!enableCustomIntegration()) {
       return (
         <DialogContent>
           <h2>Applications</h2>
           <Row>{this.renderExternalEditor()}</Row>
           <Row>{this.renderSelectedShell()}</Row>
+          <Row>{this.renderCopyPathNormalization()}</Row>
         </DialogContent>
       )
     }
@@ -435,6 +471,7 @@ export class Integrations extends React.Component<
             </LinkButton>
           </p>
         </fieldset>
+        <Row>{this.renderCopyPathNormalization()}</Row>
       </DialogContent>
     )
   }