Refactor SCM View Mode Type

What It Does

Creates new type for SCM view mode and refactors accordingly.

Signed-off-by: seantan22 <[email protected]>

Author: seantan22

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

@@ -25,7 +25,7 @@ import { GitDiffHeaderWidget } from './git-diff-header-widget';
 import { ScmService } from '@theia/scm/lib/browser/scm-service';
 import { GitRepositoryProvider } from '../git-repository-provider';
 import { ScmTreeWidget } from '@theia/scm/lib/browser/scm-tree-widget';
-import { ScmPreferences, ScmConfiguration } from '@theia/scm/lib/browser/scm-preferences';
+import { ScmPreferences, ScmConfiguration, ScmViewMode } from '@theia/scm/lib/browser/scm-preferences';
 
 /* eslint-disable @typescript-eslint/no-explicit-any */
 
@@ -78,15 +78,15 @@ export class GitDiffWidget extends BaseWidget implements StatefulWidget {
         this.updateViewMode(this.scmPreferences.get('scm.defaultViewMode'));
         this.toDispose.push(this.scmPreferences.onPreferenceChanged((e: PreferenceChangeEvent<ScmConfiguration>) => {
             if (e.preferenceName === 'scm.defaultViewMode') {
-                this.updateViewMode(e.newValue!);
+                this.updateViewMode(e.newValue as ScmViewMode);
             }
         }));
     }
 
-    set viewMode(mode: 'tree' | 'list') {
+    set viewMode(mode: ScmViewMode) {
         this.resourceWidget.viewMode = mode;
     }
-    get viewMode(): 'tree' | 'list' {
+    get viewMode(): ScmViewMode {
         return this.resourceWidget.viewMode;
     }
 
@@ -104,7 +104,7 @@ export class GitDiffWidget extends BaseWidget implements StatefulWidget {
      * Updates the view mode based on the preference value.
      * @param preference the view mode preference.
      */
-    protected updateViewMode(preference: 'tree' | 'list'): void {
+    protected updateViewMode(preference: ScmViewMode): void {
         this.viewMode = preference;
     }
 

packages/git/src/browser/history/git-commit-detail-widget.tsx

@@ -26,7 +26,7 @@ import { GitCommitDetailHeaderWidget } from './git-commit-detail-header-widget';
 import { ScmService } from '@theia/scm/lib/browser/scm-service';
 import { GitDiffTreeModel } from '../diff/git-diff-tree-model';
 import { ScmTreeWidget } from '@theia/scm/lib/browser/scm-tree-widget';
-import { ScmPreferences, ScmConfiguration } from '@theia/scm/lib/browser/scm-preferences';
+import { ScmPreferences, ScmConfiguration, ScmViewMode } from '@theia/scm/lib/browser/scm-preferences';
 
 @injectable()
 export class GitCommitDetailWidget extends BaseWidget implements StatefulWidget {
@@ -39,10 +39,10 @@ export class GitCommitDetailWidget extends BaseWidget implements StatefulWidget
     @inject(GitDiffTreeModel) protected readonly model: GitDiffTreeModel;
     @inject(ScmPreferences) protected readonly scmPreferences: ScmPreferences;
 
-    set viewMode(mode: 'tree' | 'list') {
+    set viewMode(mode: ScmViewMode) {
         this.resourceWidget.viewMode = mode;
     }
-    get viewMode(): 'tree' | 'list' {
+    get viewMode(): ScmViewMode {
         return this.resourceWidget.viewMode;
     }
 
@@ -78,7 +78,7 @@ export class GitCommitDetailWidget extends BaseWidget implements StatefulWidget
         this.updateViewMode(this.scmPreferences.get('scm.defaultViewMode'));
         this.toDispose.push(this.scmPreferences.onPreferenceChanged((e: PreferenceChangeEvent<ScmConfiguration>) => {
             if (e.preferenceName === 'scm.defaultViewMode') {
-                this.updateViewMode(e.newValue!);
+                this.updateViewMode(e.newValue as ScmViewMode);
             }
         }));
 
@@ -99,7 +99,7 @@ export class GitCommitDetailWidget extends BaseWidget implements StatefulWidget
      * Updates the view mode based on the preference value.
      * @param preference the view mode preference.
      */
-    protected updateViewMode(preference: 'tree' | 'list'): void {
+    protected updateViewMode(preference: ScmViewMode): void {
         this.viewMode = preference;
     }
 

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

@@ -37,6 +37,7 @@ import { ScmQuickOpenService } from './scm-quick-open-service';
 import { ColorContribution } from '@theia/core/lib/browser/color-application-contribution';
 import { ColorRegistry, Color } from '@theia/core/lib/browser/color-registry';
 import { ScmCommand } from './scm-provider';
+import { ScmViewMode } from './scm-preferences';
 
 export const SCM_WIDGET_FACTORY_ID = ScmWidget.ID;
 export const SCM_VIEW_CONTAINER_ID = 'scm-view-container';
@@ -159,7 +160,7 @@ export class ScmContribution extends AbstractViewContribution<ScmWidget> impleme
                 }
             }
         };
-        const registerToggleViewItem = (command: Command, mode: 'tree' | 'list') => {
+        const registerToggleViewItem = (command: Command, mode: ScmViewMode) => {
             const id = command.id;
             const item: TabBarToolbarItem = {
                 id,
@@ -231,7 +232,7 @@ export class ScmContribution extends AbstractViewContribution<ScmWidget> impleme
         if (!repository) {
             return undefined;
         }
-        return  repository.provider.acceptInputCommand;
+        return repository.provider.acceptInputCommand;
     }
 
     protected readonly statusBarDisposable = new DisposableCollection();

packages/scm/src/browser/scm-preferences.ts

@@ -23,6 +23,8 @@ import {
     PreferenceContribution
 } from '@theia/core/lib/browser/preferences';
 
+export type ScmViewMode = 'tree' | 'list';
+
 export const scmPreferenceSchema: PreferenceSchema = {
     type: 'object',
     properties: {
@@ -45,7 +47,7 @@ export const scmPreferenceSchema: PreferenceSchema = {
 };
 
 export interface ScmConfiguration {
-    'scm.defaultViewMode': 'tree' | 'list';
+    'scm.defaultViewMode': ScmViewMode;
     'scm.decorations.badges': boolean;
 }
 

packages/scm/src/browser/scm-tree-model.ts

@@ -19,6 +19,7 @@ import { TreeModelImpl, TreeNode, TreeProps, CompositeTreeNode, SelectableTreeNo
 import URI from '@theia/core/lib/common/uri';
 import { ScmProvider, ScmResourceGroup, ScmResource, ScmResourceDecorations } from './scm-provider';
 import { ScmContextKeyService } from './scm-context-key-service';
+import { ScmViewMode } from './scm-preferences';
 
 export const ScmTreeModelProps = Symbol('ScmTreeModelProps');
 export interface ScmTreeModelProps {
@@ -94,8 +95,8 @@ export abstract class ScmTreeModel extends TreeModelImpl {
 
     abstract canTabToWidget(): boolean;
 
-    protected _viewMode: 'tree' | 'list' = 'list';
-    set viewMode(id: 'tree' | 'list') {
+    protected _viewMode: ScmViewMode = 'list';
+    set viewMode(id: ScmViewMode) {
         const oldSelection = this.selectedNodes;
         this._viewMode = id;
         if (this.root) {
@@ -109,7 +110,7 @@ export abstract class ScmTreeModel extends TreeModelImpl {
             }
         }
     }
-    get viewMode(): 'tree' | 'list' {
+    get viewMode(): ScmViewMode {
         return this._viewMode;
     }
 

packages/scm/src/browser/scm-tree-widget.tsx

@@ -33,6 +33,7 @@ import { EditorManager, DiffNavigatorProvider } from '@theia/editor/lib/browser'
 import { FileStat } from '@theia/filesystem/lib/common';
 import { IconThemeService } from '@theia/core/lib/browser/icon-theme-service';
 import { ScmFileChangeRootNode, ScmFileChangeGroupNode, ScmFileChangeFolderNode, ScmFileChangeNode } from './scm-tree-model';
+import { ScmViewMode } from './scm-preferences';
 
 @injectable()
 export class ScmTreeWidget extends TreeWidget {
@@ -69,13 +70,13 @@ export class ScmTreeWidget extends TreeWidget {
         this.model = treeModel as ScmTreeModel;
     }
 
-    set viewMode(id: 'tree' | 'list') {
+    set viewMode(id: ScmViewMode) {
         // Close the search box because the structure of the tree will change dramatically
         // and the search results will be out of date.
         this.searchBox.hide();
         this.model.viewMode = id;
     }
-    get viewMode(): 'tree' | 'list' {
+    get viewMode(): ScmViewMode {
         return this.model.viewMode;
     }
 

packages/scm/src/browser/scm-widget.tsx

@@ -27,7 +27,7 @@ import { ScmAmendWidget } from './scm-amend-widget';
 import { ScmNoRepositoryWidget } from './scm-no-repository-widget';
 import { ScmService } from './scm-service';
 import { ScmTreeWidget } from './scm-tree-widget';
-import { ScmPreferences, ScmConfiguration } from './scm-preferences';
+import { ScmPreferences, ScmConfiguration, ScmViewMode } from './scm-preferences';
 
 @injectable()
 export class ScmWidget extends BaseWidget implements StatefulWidget {
@@ -43,10 +43,10 @@ export class ScmWidget extends BaseWidget implements StatefulWidget {
     @inject(ScmNoRepositoryWidget) readonly noRepositoryWidget: ScmNoRepositoryWidget;
     @inject(ScmPreferences) protected readonly scmPreferences: ScmPreferences;
 
-    set viewMode(mode: 'tree' | 'list') {
+    set viewMode(mode: ScmViewMode) {
         this.resourceWidget.viewMode = mode;
     }
-    get viewMode(): 'tree' | 'list' {
+    get viewMode(): ScmViewMode {
         return this.resourceWidget.viewMode;
     }
 
@@ -80,7 +80,7 @@ export class ScmWidget extends BaseWidget implements StatefulWidget {
         this.updateViewMode(this.scmPreferences.get('scm.defaultViewMode'));
         this.toDispose.push(this.scmPreferences.onPreferenceChanged((e: PreferenceChangeEvent<ScmConfiguration>) => {
             if (e.preferenceName === 'scm.defaultViewMode') {
-                this.updateViewMode(e.newValue!);
+                this.updateViewMode(e.newValue as ScmViewMode);
             }
         }));
     }
@@ -93,7 +93,7 @@ export class ScmWidget extends BaseWidget implements StatefulWidget {
      * Updates the view mode based on the preference value.
      * @param preference the view mode preference.
      */
-    protected updateViewMode(preference: 'tree' | 'list'): void {
+    protected updateViewMode(preference: ScmViewMode): void {
         this.viewMode = preference;
     }