Closes #204 - Adds tag support to commands

Author: eamodio

CHANGELOG.md

@@ -8,6 +8,13 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 ### Added
 - Adds `Open Working File` command (`gitlens.openWorkingFile`) - opens the working file for the active file revision -- closes [#236](https://github.com/eamodio/vscode-gitlens/issues/236)
 - Adds `Open Revision...` command (`gitlens.openFileRevision`) - opens the selected revision for the active file
+- Adds tags to the `Compare File with Branch...` command (`gitlens.diffWithBranch`) -- closes [#204](https://github.com/eamodio/vscode-gitlens/issues/204)
+- Adds tags to the `Directory Compare Working Tree with...` command (`gitlens.diffDirectory`) -- closes [#204](https://github.com/eamodio/vscode-gitlens/issues/204)
+- Adds `Show Branches and Tags` to quick pick menu shown by the `Compare File with Revision...` command (`gitlens.diffWithRevision`) -- closes [#204](https://github.com/eamodio/vscode-gitlens/issues/204)
+- Adds `Show Branches and Tags` to quick pick menu shown by the `Open Revision...` command (`gitlens.openFileRevision`) -- closes [#204](https://github.com/eamodio/vscode-gitlens/issues/204)
+
+### Changed
+- Renames `Compare File with Branch...` command (`gitlens.diffWithBranch`) to `Compare File with Branch or Tag...`
 
 ### Fixed
 - Fixes issues with commit paging in certain quick pick menus

README.md

@@ -308,9 +308,9 @@ While GitLens is highly customizable and provides many [configuration settings](
 
 - Provides easy access to the following comparison commands via the `Command Palette` as well as in context via the many provided quick pick menus
 
-- Adds a `Directory Compare Working Tree with...` command (`gitlens.diffDirectory`) to open the configured Git difftool to compare the working tree with the selected branch
+- Adds a `Directory Compare Working Tree with...` command (`gitlens.diffDirectory`) to open the configured Git difftool to compare the working tree with the selected branch or tag
 
-- Adds a `Compare File with Branch...` command (`gitlens.diffWithBranch`) to compare the active file with the same file on the selected branch
+- Adds a `Compare File with Branch or Tag...` command (`gitlens.diffWithBranch`) to compare the active file with the same file on the selected branch or tag
 
 - Adds a `Compare File with Next Revision` command (`gitlens.diffWithNext`) with a shortcut of `alt+.` to compare the active file/diff with the next commit revision
 

package.json

@@ -1144,7 +1144,7 @@
             },
             {
                 "command": "gitlens.diffWithBranch",
-                "title": "Compare File with Branch...",
+                "title": "Compare File with Branch or Tag...",
                 "category": "GitLens"
             },
             {

src/commands/common.ts

@@ -290,22 +290,24 @@ export abstract class EditorCommand extends Disposable {
     abstract execute(editor: TextEditor, edit: TextEditorEdit, ...args: any[]): any;
 }
 
-export async function openEditor(uri: Uri, options?: TextDocumentShowOptions): Promise<TextEditor | undefined> {
+export async function openEditor(uri: Uri, options: TextDocumentShowOptions & { rethrow?: boolean } = {}): Promise<TextEditor | undefined> {
+    const { rethrow, ...opts } = options;
     try {
-        const defaults: TextDocumentShowOptions = {
-            preserveFocus: false,
-            preview: true,
-            viewColumn: (window.activeTextEditor && window.activeTextEditor.viewColumn) || 1
-        };
-
         if (uri instanceof GitUri) {
             uri = uri.fileUri(false);
         }
 
         const document = await workspace.openTextDocument(uri);
-        return window.showTextDocument(document, { ...defaults, ...(options || {}) });
+        return window.showTextDocument(document, {
+            preserveFocus: false,
+            preview: true,
+            viewColumn: (window.activeTextEditor && window.activeTextEditor.viewColumn) || 1,
+            ...opts
+        });
     }
     catch (ex) {
+        if (rethrow) throw ex;
+
         Logger.error(ex, 'openEditor');
         return undefined;
     }

src/commands/diffDirectory.ts

@@ -1,13 +1,13 @@
 'use strict';
-import { commands, TextEditor, Uri, window } from 'vscode';
+import { CancellationTokenSource, commands, TextEditor, Uri, window } from 'vscode';
 import { ActiveEditorCommand, Commands, getCommandUri } from './common';
 import { CommandContext, isCommandViewContextWithRef } from '../commands';
 import { BuiltInCommands, GlyphChars } from '../constants';
 import { ComparisionResultsNode } from '../views/explorerNodes';
 import { GitService } from '../gitService';
 import { Logger } from '../logger';
 import { Messages } from '../messages';
-import { BranchesQuickPick, CommandQuickPickItem } from '../quickPicks';
+import { BranchesAndTagsQuickPick, CommandQuickPickItem } from '../quickPicks';
 
 export interface DiffDirectoryCommandCommandArgs {
     ref1?: string;
@@ -50,20 +50,32 @@ export class DiffDirectoryCommand extends ActiveEditorCommand {
     async execute(editor?: TextEditor, uri?: Uri, args: DiffDirectoryCommandCommandArgs = {}): Promise<any> {
         uri = getCommandUri(uri, editor);
 
+        let progressCancellation: CancellationTokenSource | undefined;
+
         try {
             const repoPath = await this.git.getRepoPath(uri);
             if (!repoPath) return Messages.showNoRepositoryWarningMessage(`Unable to open directory compare`);
 
             if (!args.ref1) {
                 args = { ...args };
 
-                const branches = await this.git.getBranches(repoPath);
-                const pick = await BranchesQuickPick.show(branches, `Compare Working Tree to ${GlyphChars.Ellipsis}`);
+                const placeHolder = `Compare Working Tree to ${GlyphChars.Ellipsis}`;
+
+                progressCancellation = BranchesAndTagsQuickPick.showProgress(placeHolder);
+
+                const [branches, tags] = await Promise.all([
+                    this.git.getBranches(repoPath),
+                    this.git.getTags(repoPath)
+                ]);
+
+                if (progressCancellation.token.isCancellationRequested) return undefined;
+
+                const pick = await BranchesAndTagsQuickPick.show(branches, tags, placeHolder, { progressCancellation: progressCancellation });
                 if (pick === undefined) return undefined;
 
                 if (pick instanceof CommandQuickPickItem) return pick.execute();
 
-                args.ref1 = pick.branch.name;
+                args.ref1 = pick.name;
                 if (args.ref1 === undefined) return undefined;
             }
 
@@ -82,5 +94,8 @@ export class DiffDirectoryCommand extends ActiveEditorCommand {
             Logger.error(ex, 'DiffDirectoryCommand');
             return window.showErrorMessage(`Unable to open directory compare. See output channel for more details`);
         }
+        finally {
+            progressCancellation && progressCancellation.dispose();
+        }
     }
 }

src/commands/diffWith.ts

@@ -123,7 +123,13 @@ export class DiffWithCommand extends ActiveEditorCommand {
 
             let lhsPrefix = '';
             if (lhs === undefined && args.rhs.sha === '') {
-                lhsPrefix = 'deleted in ';
+                if (rhs !== undefined) {
+                    lhsPrefix = 'not in ';
+                    rhsPrefix = '';
+                }
+                else {
+                    lhsPrefix = 'deleted in ';
+                }
             }
 
             if (args.lhs.title === undefined && args.lhs.sha !== GitService.deletedSha && (lhs !== undefined || lhsPrefix !== '')) {

src/commands/diffWithBranch.ts

@@ -5,7 +5,7 @@ import { GlyphChars } from '../constants';
 import { DiffWithCommandArgs } from './diffWith';
 import { GitService, GitUri } from '../gitService';
 import { Messages } from '../messages';
-import { BranchesQuickPick, CommandQuickPickItem } from '../quickPicks';
+import { BranchesAndTagsQuickPick, CommandQuickPickItem } from '../quickPicks';
 import * as path from 'path';
 
 export interface DiffWithBranchCommandArgs {
@@ -35,43 +35,57 @@ export class DiffWithBranchCommand extends ActiveEditorCommand {
         const gitUri = await GitUri.fromUri(uri, this.git);
         if (!gitUri.repoPath) return Messages.showNoRepositoryWarningMessage(`Unable to open branch compare`);
 
-        const branches = await this.git.getBranches(gitUri.repoPath);
-        const pick = await BranchesQuickPick.show(branches, `Compare ${path.basename(gitUri.fsPath)} to ${GlyphChars.Ellipsis}`, args.goBackCommand);
-        if (pick === undefined) return undefined;
+        const placeHolder = `Compare ${path.basename(gitUri.fsPath)} with ${GlyphChars.Ellipsis}`;
+        const progressCancellation = BranchesAndTagsQuickPick.showProgress(placeHolder);
 
-        if (pick instanceof CommandQuickPickItem) return pick.execute();
+        try {
+            const [branches, tags] = await Promise.all([
+                this.git.getBranches(gitUri.repoPath),
+                this.git.getTags(gitUri.repoPath)
+            ]);
 
-        const branch = pick.branch.name;
-        if (branch === undefined) return undefined;
+            if (progressCancellation.token.isCancellationRequested) return undefined;
 
-        let renamedUri: Uri | undefined;
-        let renamedTitle: string | undefined;
+            const pick = await BranchesAndTagsQuickPick.show(branches, tags, placeHolder, { progressCancellation: progressCancellation, goBackCommand: args.goBackCommand });
+            if (pick === undefined) return undefined;
 
-        // Check to see if this file has been renamed
-        const statuses = await this.git.getDiffStatus(gitUri.repoPath, 'HEAD', branch, { filter: 'R' });
-        if (statuses !== undefined) {
-            const fileName = GitService.normalizePath(path.relative(gitUri.repoPath, gitUri.fsPath));
-            const rename = statuses.find(s => s.fileName === fileName);
-            if (rename !== undefined && rename.originalFileName !== undefined) {
-                renamedUri = Uri.file(path.join(gitUri.repoPath, rename.originalFileName));
-                renamedTitle = `${path.basename(rename.originalFileName)} (${branch})`;
+            if (pick instanceof CommandQuickPickItem) return pick.execute();
+
+            const ref = pick.name;
+            if (ref === undefined) return undefined;
+
+            let renamedUri: Uri | undefined;
+            let renamedTitle: string | undefined;
+
+            // Check to see if this file has been renamed
+            const statuses = await this.git.getDiffStatus(gitUri.repoPath, 'HEAD', ref, { filter: 'R' });
+            if (statuses !== undefined) {
+                const fileName = GitService.normalizePath(path.relative(gitUri.repoPath, gitUri.fsPath));
+                const rename = statuses.find(s => s.fileName === fileName);
+                if (rename !== undefined && rename.originalFileName !== undefined) {
+                    renamedUri = Uri.file(path.join(gitUri.repoPath, rename.originalFileName));
+                    renamedTitle = `${path.basename(rename.originalFileName)} (${ref})`;
+                }
             }
-        }
 
-        const diffArgs: DiffWithCommandArgs = {
-            repoPath: gitUri.repoPath,
-            lhs: {
-                sha: pick.branch.remote ? `remotes/${branch}` : branch,
-                uri: renamedUri || gitUri as Uri,
-                title: renamedTitle || `${path.basename(gitUri.fsPath)} (${branch})`
-            },
-            rhs: {
-                sha: '',
-                uri: gitUri as Uri
-            },
-            line: args.line,
-            showOptions: args.showOptions
-        };
-        return commands.executeCommand(Commands.DiffWith, diffArgs);
+            const diffArgs: DiffWithCommandArgs = {
+                repoPath: gitUri.repoPath,
+                lhs: {
+                    sha: pick.remote ? `remotes/${ref}` : ref,
+                    uri: renamedUri || gitUri as Uri,
+                    title: renamedTitle || `${path.basename(gitUri.fsPath)} (${ref})`
+                },
+                rhs: {
+                    sha: '',
+                    uri: gitUri as Uri
+                },
+                line: args.line,
+                showOptions: args.showOptions
+            };
+            return commands.executeCommand(Commands.DiffWith, diffArgs);
+        }
+        finally {
+            progressCancellation.dispose();
+        }
     }
 }

src/commands/diffWithRevision.ts

@@ -7,7 +7,7 @@ import { DiffWithCommandArgs } from './diffWith';
 import { GitService, GitUri } from '../gitService';
 import { Logger } from '../logger';
 import { Messages } from '../messages';
-import { CommandQuickPickItem, FileHistoryQuickPick } from '../quickPicks';
+import { CommandQuickPickItem, FileHistoryQuickPick, ShowBranchesAndTagsQuickPickItem } from '../quickPicks';
 
 export interface DiffWithRevisionCommandArgs {
     maxCount?: number;
@@ -36,7 +36,9 @@ export class DiffWithRevisionCommand extends ActiveEditorCommand {
 
         const gitUri = await GitUri.fromUri(uri, this.git);
 
-        const progressCancellation = FileHistoryQuickPick.showProgress(gitUri);
+        const placeHolder = `Compare ${gitUri.getFormattedPath()}${gitUri.sha ? ` ${Strings.pad(GlyphChars.Dot, 1, 1)} ${gitUri.shortSha}` : ''} with ${GlyphChars.Ellipsis}`;
+        const progressCancellation = FileHistoryQuickPick.showProgress(placeHolder);
+
         try {
             const log = await this.git.getLogForFile(gitUri.repoPath, gitUri.fsPath, { maxCount: args.maxCount, ref: gitUri.sha });
             if (log === undefined) return Messages.showFileNotUnderSourceControlWarningMessage('Unable to open history compare');
@@ -60,9 +62,13 @@ export class DiffWithRevisionCommand extends ActiveEditorCommand {
                 }
             }
 
-            const label = `${gitUri.getFormattedPath()}${gitUri.sha ? ` ${Strings.pad(GlyphChars.Dot, 1, 1)} ${gitUri.shortSha}` : ''}`;
-            const pick = await FileHistoryQuickPick.show(this.git, log, gitUri, label, progressCancellation, {
+            const pick = await FileHistoryQuickPick.show(this.git, log, gitUri, placeHolder, {
                 pickerOnly: true,
+                progressCancellation: progressCancellation,
+                currentCommand: new CommandQuickPickItem({
+                    label: `go back ${GlyphChars.ArrowBack}`,
+                    description: `${Strings.pad(GlyphChars.Dash, 2, 3)} to history of ${GlyphChars.Space}$(file-text) ${gitUri.getFormattedPath()}${gitUri.sha ? ` from ${GlyphChars.Space}$(git-commit) ${gitUri.shortSha}` : ''}`
+                }, Commands.DiffWithRevision, [uri, { ...args }]),
                 nextPageCommand: args.nextPageCommand,
                 previousPageCommand: previousPageCommand,
                 showAllCommand: log !== undefined && log.truncated
@@ -74,12 +80,26 @@ export class DiffWithRevisionCommand extends ActiveEditorCommand {
             });
             if (pick === undefined) return undefined;
 
-            if (pick instanceof CommandQuickPickItem) return pick.execute();
+            let ref: string;
+
+            if (pick instanceof ShowBranchesAndTagsQuickPickItem) {
+                const branchOrTag = await pick.execute();
+                if (branchOrTag === undefined) return undefined;
+
+                if (branchOrTag instanceof CommandQuickPickItem) return branchOrTag.execute();
+
+                ref = branchOrTag.name;
+            }
+            else {
+                if (pick instanceof CommandQuickPickItem) return pick.execute();
+
+                ref = pick.commit.sha;
+            }
 
             const diffArgs: DiffWithCommandArgs = {
                 repoPath: gitUri.repoPath,
                 lhs: {
-                    sha: pick.commit.sha,
+                    sha: ref,
                     uri: gitUri as Uri
                 },
                 rhs: {