Move Git history view to scm-extra package

Signed-off-by: Nigel Westbury <nigelipse@miegel.org>

.travis.yml

@@ -57,6 +57,7 @@ cache:
     - packages/preview/node_modules
     - packages/process/node_modules
     - packages/python/node_modules
+    - packages/scm-extra/node_modules
     - packages/scm/node_modules
     - packages/search-in-workspace/node_modules
     - packages/task/node_modules

CHANGELOG.md

@@ -7,6 +7,9 @@
 Breaking changes:
 
 - [core] fixed typo (highligh -> highlight) in caption highlight fragment [#7050](https://github.com/eclipse-theia/theia/pull/7050)
+- [scm][git] the History view (GitHistoryWidget) has moved from the git package to a new   package, scm-extra, and
+  renamed to ScmHistoryWidget.  GitNavigableListWidget has also moved.
+  CSS classes have been moved renamed accordingly.  [6381](https://github.com/eclipse-theia/theia/pull/6381)
 
 ## v0.15.0
 

configs/root-compilation.tsconfig.json

@@ -124,6 +124,9 @@
     {
       "path": "../packages/scm/compile.tsconfig.json"
     },
+    {
+      "path": "../packages/scm-extra/compile.tsconfig.json"
+    },
     {
       "path": "../packages/search-in-workspace/compile.tsconfig.json"
     },

examples/browser/package.json

@@ -44,6 +44,7 @@
     "@theia/preview": "^0.15.0",
     "@theia/process": "^0.15.0",
     "@theia/scm": "^0.15.0",
+    "@theia/scm-extra": "^0.15.0",
     "@theia/search-in-workspace": "^0.15.0",
     "@theia/task": "^0.15.0",
     "@theia/terminal": "^0.15.0",

examples/electron/package.json

@@ -41,6 +41,7 @@
     "@theia/preview": "^0.15.0",
     "@theia/process": "^0.15.0",
     "@theia/scm": "^0.15.0",
+    "@theia/scm-extra": "^0.15.0",
     "@theia/search-in-workspace": "^0.15.0",
     "@theia/task": "^0.15.0",
     "@theia/terminal": "^0.15.0",

packages/core/src/browser/shell/application-shell.ts

@@ -52,12 +52,14 @@ export type ApplicationShellLayoutVersion =
     /** layout versioning is introduced, unversioned layout are not compatible */
     2.0 |
     /** view containers are introduced, backward compatible to 2.0 */
-    3.0;
+    3.0 |
+    /** git history view is replaced by a more generic scm history view, backward compatible to 3.0 */
+    4.0;
 
 /**
  * When a version is increased, make sure to introduce a migration (ApplicationShellLayoutMigration) to this version.
  */
-export const applicationShellLayoutVersion: ApplicationShellLayoutVersion = 3.0;
+export const applicationShellLayoutVersion: ApplicationShellLayoutVersion = 4.0;
 
 export const ApplicationShellOptions = Symbol('ApplicationShellOptions');
 export const DockPanelRendererFactory = Symbol('DockPanelRendererFactory');

packages/git/compile.tsconfig.json

@@ -27,6 +27,9 @@
     {
       "path": "../scm/compile.tsconfig.json"
     },
+    {
+      "path": "../scm-extra/compile.tsconfig.json"
+    },
     {
       "path": "../workspace/compile.tsconfig.json"
     }

packages/git/package.json

@@ -9,6 +9,7 @@
     "@theia/languages": "^0.15.0",
     "@theia/navigator": "^0.15.0",
     "@theia/scm": "^0.15.0",
+    "@theia/scm-extra": "^0.15.0",
     "@theia/workspace": "^0.15.0",
     "@types/diff": "^3.2.2",
     "@types/p-queue": "^2.3.1",

packages/git/src/browser/blame/blame-contribution.ts

@@ -21,7 +21,7 @@ import { BlameDecorator } from './blame-decorator';
 import { EditorManager, EditorKeybindingContexts, EditorWidget, EditorTextFocusContext, StrictEditorTextFocusContext } from '@theia/editor/lib/browser';
 import { BlameManager } from './blame-manager';
 import URI from '@theia/core/lib/common/uri';
-import { EDITOR_CONTEXT_MENU_GIT } from '../git-contribution';
+import { EDITOR_CONTEXT_MENU_SCM } from '@theia/scm-extra/lib/browser/scm-extra-contribution';
 
 import debounce = require('lodash.debounce');
 
@@ -136,7 +136,7 @@ export class BlameContribution implements CommandContribution, KeybindingContrib
     }
 
     registerMenus(menus: MenuModelRegistry): void {
-        menus.registerMenuAction(EDITOR_CONTEXT_MENU_GIT, {
+        menus.registerMenuAction(EDITOR_CONTEXT_MENU_SCM, {
             commandId: BlameCommands.TOGGLE_GIT_ANNOTATIONS.id,
         });
     }

packages/git/src/browser/diff/git-diff-contribution.ts

@@ -19,6 +19,7 @@ import { FrontendApplication, AbstractViewContribution } from '@theia/core/lib/b
 import { WidgetManager } from '@theia/core/lib/browser/widget-manager';
 import { injectable, inject } from 'inversify';
 import { GitDiffWidget, GIT_DIFF } from './git-diff-widget';
+import { ScmService } from '@theia/scm/lib/browser/scm-service';
 import { open, OpenerService } from '@theia/core/lib/browser';
 import { NavigatorContextMenu, FileNavigatorContribution } from '@theia/navigator/lib/browser/navigator-contribution';
 import { UriCommandHandler } from '@theia/core/lib/common/uri-command-handler';
@@ -27,8 +28,7 @@ import { FileSystem } from '@theia/filesystem/lib/common';
 import { DiffUris } from '@theia/core/lib/browser/diff-uris';
 import URI from '@theia/core/lib/common/uri';
 import { GIT_RESOURCE_SCHEME } from '../git-resource';
-import { Git } from '../../common';
-import { GitRepositoryProvider } from '../git-repository-provider';
+import { Git, Repository } from '../../common';
 import { WorkspaceRootUriAwareCommandHandler } from '@theia/workspace/lib/browser/workspace-commands';
 import { WorkspaceService } from '@theia/workspace/lib/browser';
 import { TabBarToolbarContribution, TabBarToolbarRegistry } from '@theia/core/lib/browser/shell/tab-bar-toolbar';
@@ -65,7 +65,7 @@ export class GitDiffContribution extends AbstractViewContribution<GitDiffWidget>
         @inject(FileSystem) protected readonly fileSystem: FileSystem,
         @inject(OpenerService) protected openerService: OpenerService,
         @inject(MessageService) protected readonly notifications: MessageService,
-        @inject(GitRepositoryProvider) protected readonly repositoryProvider: GitRepositoryProvider
+        @inject(ScmService) protected readonly scmService: ScmService
     ) {
         super({
             widgetId: GIT_DIFF,
@@ -85,8 +85,8 @@ export class GitDiffContribution extends AbstractViewContribution<GitDiffWidget>
 
     registerCommands(commands: CommandRegistry): void {
         commands.registerCommand(GitDiffCommands.OPEN_FILE_DIFF, this.newWorkspaceRootUriAwareCommandHandler({
-            isVisible: uri => !!this.repositoryProvider.findRepository(uri),
-            isEnabled: uri => !!this.repositoryProvider.findRepository(uri),
+            isVisible: uri => !!this.findGitRepository(uri),
+            isEnabled: uri => !!this.findGitRepository(uri),
             execute: async fileUri => {
                 await this.quickOpenService.chooseTagsAndBranches(
                     async (fromRevision, toRevision) => {
@@ -112,7 +112,7 @@ export class GitDiffContribution extends AbstractViewContribution<GitDiffWidget>
                                 }
                             }
                         }
-                    }, this.repositoryProvider.findRepository(fileUri));
+                    }, this.findGitRepository(fileUri));
             }
         }));
     }
@@ -126,6 +126,14 @@ export class GitDiffContribution extends AbstractViewContribution<GitDiffWidget>
         });
     }
 
+    protected findGitRepository(uri: URI): Repository | undefined {
+        const repo = this.scmService.findRepository(uri);
+        if (repo && repo.provider.id === 'git') {
+            return { localUri: repo.provider.rootUri };
+        }
+        return undefined;
+    }
+
     async showWidget(options: Git.Options.Diff): Promise<GitDiffWidget> {
         const widget = await this.widget;
         await widget.setContent(options);

packages/git/src/browser/diff/git-diff-widget.tsx

@@ -18,20 +18,25 @@ import { inject, injectable, postConstruct } from 'inversify';
 import URI from '@theia/core/lib/common/uri';
 import { StatefulWidget, DiffUris, Message } from '@theia/core/lib/browser';
 import { EditorManager, EditorOpenerOptions, EditorWidget, DiffNavigatorProvider, DiffNavigator } from '@theia/editor/lib/browser';
+import { ScmRepository } from '@theia/scm/lib/browser/scm-repository';
 import { GitFileChange, GitFileStatus, Git, WorkingDirectoryStatus } from '../../common';
+import { GitScmProvider, GitScmFileChange } from '../git-scm-provider';
 import { GitWatcher } from '../../common';
 import { GIT_RESOURCE_SCHEME } from '../git-resource';
-import { GitNavigableListWidget, GitItemComponent } from '../git-navigable-list-widget';
-import { GitFileChangeNode } from '../git-file-change-node';
+import { ScmNavigableListWidget, ScmItemComponent } from '@theia/scm-extra/lib/browser/scm-navigable-list-widget';
 import { Deferred } from '@theia/core/lib/common/promise-util';
+import { GitRepositoryProvider } from '../git-repository-provider';
 import * as React from 'react';
 import { MaybePromise } from '@theia/core/lib/common/types';
+import { ScmFileChangeNode } from '@theia/scm-extra/lib/browser/scm-file-change-node';
 
 /* eslint-disable no-null/no-null */
 
+type GitFileChangeNode = ScmFileChangeNode & { fileChange: GitScmFileChange };
+
 export const GIT_DIFF = 'git-diff';
 @injectable()
-export class GitDiffWidget extends GitNavigableListWidget<GitFileChangeNode> implements StatefulWidget {
+export class GitDiffWidget extends ScmNavigableListWidget<GitFileChangeNode> implements StatefulWidget {
 
     protected readonly GIT_DIFF_TITLE = 'Diff';
 
@@ -45,6 +50,7 @@ export class GitDiffWidget extends GitNavigableListWidget<GitFileChangeNode> imp
     protected deferredListContainer = new Deferred<HTMLElement>();
 
     @inject(Git) protected readonly git: Git;
+    @inject(GitRepositoryProvider) protected readonly repositoryProvider: GitRepositoryProvider;
     @inject(DiffNavigatorProvider) protected readonly diffNavigatorProvider: DiffNavigatorProvider;
     @inject(EditorManager) protected readonly editorManager: EditorManager;
     @inject(GitWatcher) protected readonly gitWatcher: GitWatcher;
@@ -58,6 +64,7 @@ export class GitDiffWidget extends GitNavigableListWidget<GitFileChangeNode> imp
         this.title.closable = true;
         this.title.iconClass = 'theia-git-diff-icon';
 
+        this.addClass('theia-scm');
         this.addClass('theia-git');
     }
 
@@ -69,7 +76,7 @@ export class GitDiffWidget extends GitNavigableListWidget<GitFileChangeNode> imp
             }
         }));
         this.toDispose.push(this.labelProvider.onDidChange(event => {
-            const affectsFiles = this.fileChangeNodes.some(node => event.affects(new URI(node.uri)));
+            const affectsFiles = this.fileChangeNodes.some(node => event.affects(new URI(node.fileChange.uri)));
             if (this.options && affectsFiles) {
                 this.setContent(this.options);
             }
@@ -90,17 +97,29 @@ export class GitDiffWidget extends GitNavigableListWidget<GitFileChangeNode> imp
 
     async setContent(options: Git.Options.Diff): Promise<void> {
         this.options = options;
-        const repository = this.repositoryProvider.findRepositoryOrSelected(options);
-        if (repository) {
-            const fileChanges: GitFileChange[] = await this.git.diff(repository, {
+        const scmRepository = this.findRepositoryOrSelected(options.uri);
+        if (scmRepository && scmRepository.provider.id === 'git') {
+            const provider = scmRepository.provider as GitScmProvider;
+            const repository = { localUri: scmRepository.provider.rootUri };
+            const gitFileChanges = await this.git.diff(repository, {
                 range: options.range,
                 uri: options.uri
             });
-            this.fileChangeNodes = fileChanges;
+            const scmFileChanges: GitFileChangeNode[] = gitFileChanges
+                .map(change => new GitScmFileChange(change, provider, options.range))
+                .map(fileChange => ({ fileChange, commitId: fileChange.gitFileChange.uri }));
+            this.fileChangeNodes = scmFileChanges;
             this.update();
         }
     }
 
+    protected findRepositoryOrSelected(uri?: string): ScmRepository | undefined {
+        if (uri) {
+            return this.scmService.findRepository(new URI(uri));
+        }
+        return this.scmService.selectedRepository;
+    }
+
     storeState(): object {
         const { fileChangeNodes, options } = this;
         return {
@@ -124,10 +143,10 @@ export class GitDiffWidget extends GitNavigableListWidget<GitFileChangeNode> imp
     }
 
     protected render(): React.ReactNode {
-        this.gitNodes = this.fileChangeNodes;
+        this.scmNodes = this.fileChangeNodes;
         const commitishBar = this.renderDiffListHeader();
         const fileChangeList = this.renderFileChangeList();
-        return <div className='git-diff-container'>{commitishBar}{fileChangeList}</div>;
+        return <div className='scm-diff-container'>{commitishBar}{fileChangeList}</div>;
     }
 
     protected renderDiffListHeader(): React.ReactNode {
@@ -159,7 +178,7 @@ export class GitDiffWidget extends GitNavigableListWidget<GitFileChangeNode> imp
     }
     protected renderPath(): React.ReactNode {
         if (this.options.uri) {
-            const path = this.gitLabelProvider.relativePath(this.options.uri);
+            const path = this.scmLabelProvider.relativePath(this.options.uri);
             if (path.length > 0) {
                 return '/' + path;
             } else {
@@ -241,24 +260,24 @@ export class GitDiffWidget extends GitNavigableListWidget<GitFileChangeNode> imp
     protected doAddGitDiffListKeyListeners(id: string): void {
         const container = document.getElementById(id);
         if (container) {
-            this.addGitListNavigationKeyListeners(container);
+            this.addListNavigationKeyListeners(container);
         }
     }
 
     protected renderGitItem(change: GitFileChangeNode): React.ReactNode {
-        return <GitItemComponent key={change.uri.toString()} {...{
+        return <ScmItemComponent key={change.fileChange.uri.toString()} {...{
             labelProvider: this.labelProvider,
-            gitLabelProvider: this.gitLabelProvider,
+            scmLabelProvider: this.scmLabelProvider,
             change,
-            revealChange: () => this.revealChange(change),
+            revealChange: () => this.revealChange(change.fileChange.gitFileChange),
             selectNode: () => this.selectNode(change)
         }} />;
     }
 
     protected navigateRight(): void {
         const selected = this.getSelected();
-        if (selected && GitFileChangeNode.is(selected)) {
-            const uri = this.getUriToOpen(selected);
+        if (selected) {
+            const uri = this.getUriToOpen(selected.fileChange.gitFileChange);
             this.editorManager.getByUri(uri).then(widget => {
                 if (widget) {
                     const diffNavigator: DiffNavigator = this.diffNavigatorProvider(widget.editor);
@@ -269,19 +288,19 @@ export class GitDiffWidget extends GitNavigableListWidget<GitFileChangeNode> imp
                         this.openSelected();
                     }
                 } else {
-                    this.revealChange(selected);
+                    this.revealChange(selected.fileChange.gitFileChange);
                 }
             });
-        } else if (this.gitNodes.length > 0) {
-            this.selectNode(this.gitNodes[0]);
+        } else if (this.scmNodes.length > 0) {
+            this.selectNode(this.scmNodes[0]);
             this.openSelected();
         }
     }
 
     protected navigateLeft(): void {
         const selected = this.getSelected();
-        if (GitFileChangeNode.is(selected)) {
-            const uri = this.getUriToOpen(selected);
+        if (selected) {
+            const uri = this.getUriToOpen(selected.fileChange.gitFileChange);
             this.editorManager.getByUri(uri).then(widget => {
                 if (widget) {
                     const diffNavigator: DiffNavigator = this.diffNavigatorProvider(widget.editor);
@@ -292,27 +311,27 @@ export class GitDiffWidget extends GitNavigableListWidget<GitFileChangeNode> imp
                         this.openSelected();
                     }
                 } else {
-                    this.revealChange(selected);
+                    this.revealChange(selected.fileChange.gitFileChange);
                 }
             });
         }
     }
 
     protected selectNextNode(): void {
         const idx = this.indexOfSelected;
-        if (idx >= 0 && idx < this.gitNodes.length - 1) {
-            this.selectNode(this.gitNodes[idx + 1]);
-        } else if (this.gitNodes.length > 0 && (idx === -1 || idx === this.gitNodes.length - 1)) {
-            this.selectNode(this.gitNodes[0]);
+        if (idx >= 0 && idx < this.scmNodes.length - 1) {
+            this.selectNode(this.scmNodes[idx + 1]);
+        } else if (this.scmNodes.length > 0 && (idx === -1 || idx === this.scmNodes.length - 1)) {
+            this.selectNode(this.scmNodes[0]);
         }
     }
 
     protected selectPreviousNode(): void {
         const idx = this.indexOfSelected;
         if (idx > 0) {
-            this.selectNode(this.gitNodes[idx - 1]);
+            this.selectNode(this.scmNodes[idx - 1]);
         } else if (idx === 0) {
-            this.selectNode(this.gitNodes[this.gitNodes.length - 1]);
+            this.selectNode(this.scmNodes[this.scmNodes.length - 1]);
         }
     }
 
@@ -323,7 +342,7 @@ export class GitDiffWidget extends GitNavigableListWidget<GitFileChangeNode> imp
     protected openSelected(): void {
         const selected = this.getSelected();
         if (selected) {
-            this.revealChange(selected);
+            this.revealChange(selected.fileChange.gitFileChange);
         }
     }
 
@@ -363,8 +382,8 @@ export class GitDiffWidget extends GitNavigableListWidget<GitFileChangeNode> imp
 
     async openChanges(uri: URI, options?: EditorOpenerOptions): Promise<EditorWidget | undefined> {
         const stringUri = uri.toString();
-        const change = this.fileChangeNodes.find(n => n.uri.toString() === stringUri);
-        return change && this.openChange(change, options);
+        const change = this.fileChangeNodes.find(n => n.fileChange.uri.toString() === stringUri);
+        return change && this.openChange(change.fileChange.gitFileChange, options);
     }
 
     openChange(change: GitFileChange, options?: EditorOpenerOptions): Promise<EditorWidget | undefined> {

packages/git/src/browser/git-contribution.ts

@@ -18,7 +18,7 @@ import URI from '@theia/core/lib/common/uri';
 import { Command, CommandContribution, CommandRegistry, DisposableCollection, MenuContribution, MenuModelRegistry, Mutable, MenuAction } from '@theia/core';
 import { DiffUris, Widget } from '@theia/core/lib/browser';
 import { TabBarToolbarContribution, TabBarToolbarRegistry, TabBarToolbarItem } from '@theia/core/lib/browser/shell/tab-bar-toolbar';
-import { EDITOR_CONTEXT_MENU, EditorContextMenu, EditorManager, EditorOpenerOptions, EditorWidget } from '@theia/editor/lib/browser';
+import { EditorContextMenu, EditorManager, EditorOpenerOptions, EditorWidget } from '@theia/editor/lib/browser';
 import { Git, GitFileChange, GitFileStatus } from '../common';
 import { GitRepositoryTracker } from './git-repository-tracker';
 import { GitAction, GitQuickOpenService } from './git-quick-open-service';
@@ -33,8 +33,6 @@ import { GitPreferences } from './git-preferences';
 import { ColorContribution } from '@theia/core/lib/browser/color-application-contribution';
 import { ColorRegistry } from '@theia/core/lib/browser/color-registry';
 
-export const EDITOR_CONTEXT_MENU_GIT = [...EDITOR_CONTEXT_MENU, '3_git'];
-
 export namespace GIT_COMMANDS {
     export const CLONE = {
         id: 'git.clone',