Cherrypick (DonJayamanne#141)

* added new method "getGitBranch" to read current branch name

* fixed refspec containing slashes (/) in local repo

* git.viewHistory per branch, cache results and force reload when reexecute command

* support for "cherrypick" in log viewer

Author: ole1986

resources/main.css

@@ -153,6 +153,17 @@ body {
     color: white;
     padding: 0.4em;
 }
+
+.commit-hash-container .cherry-pick-button {
+    display: inline-block;
+    color: white;
+    padding: 0.4em;
+}
+
+.cherry-pick-button a, .cherry-pick-button a:hover {
+    color: white;
+}
+
 .commit-hash-container .commit-hash:hover {
     background-color: hsla(0,0%,100%,0.12);
 }

src/contracts.ts

@@ -23,6 +23,11 @@ export interface LogEntry {
     isHead: boolean;
 }
 
+export interface CherryPickEntry {
+    branch: string;
+    sha: string;
+}
+
 export interface Sha1 {
     full: string;
     short: string;

src/helpers/gitCherryPick.ts

@@ -0,0 +1,81 @@
+import { window } from 'vscode';
+import { spawn } from 'child_process';
+import { getGitPath, getGitBranch } from './gitPaths';
+import { CherryPickEntry } from '../contracts';
+import * as logger from '../logger';
+
+export async function CherryPick(rootDir: string, branch: string, sha: string): Promise<CherryPickEntry> {
+    const args = ['cherry-pick', sha];
+    // This is how you can view the log across all branches
+    const gitPath = await getGitPath();
+    let newBranch = await getGitBranch(rootDir);
+
+    const yesNo = await window.showQuickPick(['Yes', 'No'], { placeHolder: 'Cherry pick ' + sha.substr(0, 7) + ' into ' + newBranch + '?' });
+    return new Promise<CherryPickEntry>((resolve, reject) => {
+        const options = { cwd: rootDir };
+        if (yesNo === undefined || yesNo === 'No') {
+            return;
+        }
+        if (newBranch === branch) {
+            reject('Cannot cherry-pick into same branch (' + newBranch + '). Please checkout a different branch first');
+            return;
+        }
+        let error = '';
+        let entry = {} as CherryPickEntry;
+
+        logger.logInfo('git ' + args.join(' '));
+        let ls = spawn(gitPath, args, options);
+
+        ls.stdout.setEncoding('utf8');
+        ls.stdout.on('data', (data: string) => {
+            let m = data.match(/\[(\w+) ([0-9a-z]{7})\]/);
+            if (m) {
+                entry.branch = m[1];
+                entry.sha = m[2];
+            }
+        });
+
+        ls.stderr.setEncoding('utf8');
+        ls.stderr.on('data', (data: string) => {
+            error = data;
+        });
+
+        ls.on('error', function (error) {
+            logger.logError(error);
+            reject(error);
+            return;
+        });
+
+        ls.on('close', () => {
+            if (error.length > 0 || entry.branch.length <= 0) {
+                CherryPickAbort(rootDir);
+                reject(error);
+                return;
+            }
+            resolve(entry);
+        });
+    });
+}
+
+export async function CherryPickAbort(rootDir: string): Promise<null> {
+    const args = ['cherry-pick', '--abort'];
+    // This is how you can view the log across all branches
+    const gitPath = await getGitPath();
+
+    return new Promise<null>((resolve, reject) => {
+        const options = { cwd: rootDir };
+
+        logger.logInfo('git ' + args.join(' '));
+        let ls = spawn(gitPath, args, options);
+
+        ls.on('error', function (error) {
+            logger.logError(error);
+            reject(error);
+            return;
+        });
+
+        ls.on('close', () => {
+            resolve();
+        });
+    });
+}

src/logViewer/htmlGenerator.ts

@@ -135,6 +135,13 @@ export function generateHistoryHtmlView(entries: LogEntry[], canGoPrevious: bool
                                     <i class="octicon octicon-clippy"></i>
                                 </span>
                             </div>
+                            <div class="cherry-pick-button">
+                                <span class="btn hint--bottom hint--rounded hint--bounce" aria-label="Cherry pick into branch"><span aria-label="Cherry pick into branch">
+                                    <a href="${encodeURI('command:git.cherry-pick-into?' + JSON.stringify([entry.headRef, entry.sha1.full]))}">
+                                        <i class="octicon octicon-git-pull-request"></i>
+                                    </a>
+                                </span>
+                            </div>
                             <div class="commit-hash">
                                 <span class="sha-code short" data-entry-index="${entryIndex}" aria-label="${entry.sha1.short}">${entry.sha1.short}</span>
                             </div>

src/logViewer/logViewer.ts

@@ -1,6 +1,7 @@
 import * as vscode from 'vscode';
 import * as htmlGenerator from './htmlGenerator';
 import * as gitHistory from '../helpers/gitHistory';
+import * as gitCherryPick from '../helpers/gitCherryPick';
 import { LogEntry } from '../contracts';
 import * as path from 'path';
 import * as gitPaths from '../helpers/gitPaths';
@@ -146,6 +147,15 @@ export function activate(context: vscode.ExtensionContext) {
     });
     context.subscriptions.push(disposable, registration);
 
+    disposable = vscode.commands.registerCommand('git.cherry-pick-into', (branch: string, sha: string) => {
+        gitCherryPick.CherryPick(vscode.workspace.rootPath, branch, sha).then((value) => {
+            vscode.window.showInformationMessage('Cherry picked into ' + value.branch + ' (' + value.sha + ')');
+        }, (reason) => {
+            vscode.window.showErrorMessage(reason);
+        });
+    });
+    context.subscriptions.push(disposable);
+
     disposable = vscode.commands.registerCommand('git.logNavigate', (direction: string) => {
         pageIndex = pageIndex + (direction === 'next' ? 1 : -1);
         provider.update(previewUri);