added WorkspaceService.isMultiRootWorkspaceEnabled()

- fixed #4811

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

CHANGELOG.md

@@ -11,6 +11,8 @@ Breaking changes:
 - [debug] align commands with VS Code [#5102](https://github.com/theia-ide/theia/issues/5102)
     - `debug.restart` renamed to `workbench.action.debug.restart`
 - [preferences] renamed overridenPreferenceName to overriddenPreferenceName
+- [preferences] removed constructor from the `FolderPreferenceProvider` class
+- [workspace] `isMultiRootWorkspaceOpened()` is renamed into `isMultiRootWorkspaceEnabled()`
 
 ## v0.7.0
 

packages/debug/src/browser/debug-prefix-configuration.ts

@@ -90,13 +90,12 @@ export class DebugPrefixConfiguration implements CommandContribution, CommandHan
     }
 
     async onType(_lookFor: string, acceptor: (items: QuickOpenItem[]) => void): Promise<void> {
-        const isMulti: boolean = !!this.workspaceService.workspace && !this.workspaceService.workspace.isDirectory;
         const items: QuickOpenItem[] = [];
         const configurations = this.debugConfigurationManager.all;
         Array.from(configurations).forEach(config => {
             items.push(new QuickOpenItem({
                 label: config.configuration.name,
-                description: isMulti
+                description: this.workspaceService.isMultiRootWorkspaceOpened
                     ? this.labelProvider.getName(new URI(config.workspaceFolderUri))
                     : '',
                 run: (mode: QuickOpenMode) => {

packages/debug/src/browser/view/debug-configuration-widget.tsx

@@ -97,7 +97,7 @@ export class DebugConfigurationWidget extends ReactWidget {
         return configuration.name + '__CONF__' + workspaceFolderUri;
     }
     protected toName({ configuration, workspaceFolderUri }: DebugSessionOptions): string {
-        if (!workspaceFolderUri || !this.workspaceService.isMultiRootWorkspaceOpened) {
+        if (!workspaceFolderUri || !this.workspaceService.isMultiRootWorkspaceEnabled) {
             return configuration.name;
         }
         return configuration.name + ' (' + new URI(workspaceFolderUri).path.base + ')';

packages/file-search/src/browser/quick-file-open.ts

@@ -319,7 +319,7 @@ export class QuickFileOpenService implements QuickOpenModel, QuickOpenHandler {
     private async toItem(uriOrString: URI | string, group?: QuickOpenGroupItemOptions) {
         const uri = uriOrString instanceof URI ? uriOrString : new URI(uriOrString);
         let description = this.labelProvider.getLongName(uri.parent);
-        if (this.workspaceService.workspace && !this.workspaceService.workspace.isDirectory) {
+        if (this.workspaceService.isMultiRootWorkspaceOpened) {
             const rootUri = this.workspaceService.getWorkspaceRootUri(uri);
             if (rootUri) {
                 description = `${rootUri.displayName} • ${description}`;

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

@@ -116,7 +116,7 @@ export class FileNavigatorWidget extends FileTreeWidget {
 
     protected getContainerTreeNode(): TreeNode | undefined {
         const root = this.model.root;
-        if (this.workspaceService.isMultiRootWorkspaceOpened) {
+        if (this.workspaceService.isMultiRootWorkspaceEnabled) {
             return root;
         }
         if (WorkspaceNode.is(root)) {

packages/preferences/src/browser/folder-preference-provider.ts

@@ -35,23 +35,19 @@ export interface FolderPreferenceProviderOptions {
 @injectable()
 export class FolderPreferenceProvider extends AbstractResourcePreferenceProvider {
 
-    readonly folderUri: URI;
-
     @inject(WorkspaceService) protected readonly workspaceService: WorkspaceService;
+    @inject(FolderPreferenceProviderOptions) protected options: FolderPreferenceProviderOptions;
 
-    constructor(
-        @inject(FolderPreferenceProviderOptions) protected readonly options: FolderPreferenceProviderOptions
-    ) {
-        super();
-        this.folderUri = new URI(this.options.folder.uri);
+    get folderUri(): URI {
+        return new URI(this.options.folder.uri);
     }
 
     protected getUri(): URI {
         return this.options.configUri;
     }
 
     protected getScope(): PreferenceScope {
-        if (this.workspaceService.workspace && this.workspaceService.workspace.isDirectory) {
+        if (!this.workspaceService.isMultiRootWorkspaceOpened) {
             // when FolderPreferenceProvider is used as a delegate of WorkspacePreferenceProvider in a one-folder workspace
             return PreferenceScope.Workspace;
         }

packages/preferences/src/browser/folders-preferences-provider.ts

@@ -43,7 +43,6 @@ export class FoldersPreferencesProvider extends PreferenceProvider {
 
         this.updateProviders();
         this.workspaceService.onWorkspaceChanged(() => this.updateProviders());
-
         const readyPromises: Promise<void>[] = [];
         for (const provider of this.providers.values()) {
             readyPromises.push(provider.ready.catch(e => console.error(e)));

packages/preferences/src/browser/workspace-preference-provider.ts

@@ -77,7 +77,7 @@ export class WorkspacePreferenceProvider extends PreferenceProvider {
         if (!workspace) {
             return undefined;
         }
-        if (workspace.isDirectory) {
+        if (!this.workspaceService.isMultiRootWorkspaceOpened) {
             return this.folderPreferenceProvider;
         }
         return this.workspaceFileProviderFactory({
@@ -109,9 +109,8 @@ export class WorkspacePreferenceProvider extends PreferenceProvider {
     }
 
     protected ensureResourceUri(): string | undefined {
-        const workspace = this.workspaceService.workspace;
-        if (workspace && workspace.isDirectory) {
-            return workspace.uri;
+        if (this.workspaceService.workspace && !this.workspaceService.isMultiRootWorkspaceOpened) {
+            return this.workspaceService.workspace!.uri;
         }
         return undefined;
     }

packages/search-in-workspace/src/browser/search-in-workspace-result-tree-widget.tsx

@@ -315,7 +315,7 @@ export class SearchInWorkspaceResultTreeWidget extends TreeWidget {
             id: rootUri,
             parent: this.model.root as SearchInWorkspaceRoot,
             icon: FOLDER_ICON,
-            visible: this.workspaceService.workspace && !this.workspaceService.workspace.isDirectory
+            visible: this.workspaceService.isMultiRootWorkspaceOpened
         };
     }
 

packages/workspace/src/browser/workspace-commands.ts

@@ -265,7 +265,7 @@ export class WorkspaceCommandContribution implements CommandContribution {
         registry.registerCommand(WorkspaceCommands.FILE_COMPARE, this.newMultiUriAwareCommandHandler(this.compareHandler));
         this.preferences.ready.then(() => {
             registry.registerCommand(WorkspaceCommands.ADD_FOLDER, this.newMultiUriAwareCommandHandler({
-                isEnabled: () => this.workspaceService.isMultiRootWorkspaceOpened,
+                isEnabled: () => this.workspaceService.isMultiRootWorkspaceEnabled,
                 isVisible: uris => !uris.length || this.areWorkspaceRoots(uris),
                 execute: async uris => {
                     const uri = await this.fileDialogService.showOpenDialog({
@@ -293,7 +293,7 @@ export class WorkspaceCommandContribution implements CommandContribution {
             }));
             registry.registerCommand(WorkspaceCommands.REMOVE_FOLDER, this.newMultiUriAwareCommandHandler({
                 execute: uris => this.removeFolderFromWorkspace(uris),
-                isEnabled: () => this.workspaceService.isMultiRootWorkspaceOpened,
+                isEnabled: () => this.workspaceService.isMultiRootWorkspaceEnabled,
                 isVisible: uris => this.areWorkspaceRoots(uris) && this.workspaceService.saved
             }));
         });
@@ -441,7 +441,7 @@ export class WorkspaceRootUriAwareCommandHandler extends UriAwareCommandHandler<
 
     protected getUri(): URI | undefined {
         const uri = super.getUri();
-        if (this.workspaceService.isMultiRootWorkspaceOpened) {
+        if (this.workspaceService.isMultiRootWorkspaceEnabled) {
             return uri;
         }
         if (uri) {

packages/workspace/src/browser/workspace-frontend-contribution.ts

@@ -90,7 +90,7 @@ export class WorkspaceFrontendContribution implements CommandContribution, Keybi
             execute: () => this.quickOpenWorkspace.select()
         });
         commands.registerCommand(WorkspaceCommands.SAVE_WORKSPACE_AS, {
-            isEnabled: () => this.workspaceService.isMultiRootWorkspaceOpened,
+            isEnabled: () => this.workspaceService.isMultiRootWorkspaceEnabled,
             execute: () => this.saveWorkspaceAs()
         });
         commands.registerCommand(WorkspaceCommands.SAVE_AS,

packages/workspace/src/browser/workspace-service.spec.ts

@@ -600,10 +600,10 @@ describe('WorkspaceService', () => {
         });
     });
 
-    describe('isMultiRootWorkspaceOpened status', () => {
+    describe('isMultiRootWorkspaceEnabled status', () => {
         it('should be true if there is an opened workspace and preference["workspace.supportMultiRootWorkspace"] = true, otherwise false', () => {
             mockPreferenceValues['workspace.supportMultiRootWorkspace'] = true;
-            expect(wsService.isMultiRootWorkspaceOpened).to.be.false;
+            expect(wsService.isMultiRootWorkspaceEnabled).to.be.false;
 
             const file = <FileStat>{
                 uri: 'file:///home/file',
@@ -612,9 +612,31 @@ describe('WorkspaceService', () => {
             };
             wsService['_workspace'] = file;
             mockPreferenceValues['workspace.supportMultiRootWorkspace'] = true;
-            expect(wsService.isMultiRootWorkspaceOpened).to.be.true;
+            expect(wsService.isMultiRootWorkspaceEnabled).to.be.true;
 
             mockPreferenceValues['workspace.supportMultiRootWorkspace'] = false;
+            expect(wsService.isMultiRootWorkspaceEnabled).to.be.false;
+        });
+    });
+
+    describe('isMultiRootWorkspaceOpened status', () => {
+        it('should be true if there is an opened workspace and the workspace is not a directory, otherwise false', () => {
+            expect(wsService.isMultiRootWorkspaceOpened).to.be.false;
+
+            const file = <FileStat>{
+                uri: 'file:///home/file',
+                lastModification: 0,
+                isDirectory: false
+            };
+            wsService['_workspace'] = file;
+            expect(wsService.isMultiRootWorkspaceOpened).to.be.true;
+
+            const dir = <FileStat>{
+                uri: 'file:///home/dir',
+                lastModification: 0,
+                isDirectory: true
+            };
+            wsService['_workspace'] = dir;
             expect(wsService.isMultiRootWorkspaceOpened).to.be.false;
         });
     });

packages/workspace/src/browser/workspace-service.ts

@@ -261,10 +261,18 @@ export class WorkspaceService implements FrontendApplicationContribution {
     }
 
     /**
-     * Returns `true` if there is an opened workspace in theia, and the workspace has more than one root.
+     * Returns `true` if a multiple-root workspace is currently open.
      * @returns {boolean}
      */
     get isMultiRootWorkspaceOpened(): boolean {
+        return !!this.workspace && !this.workspace.isDirectory;
+    }
+
+    /**
+     * Returns `true` if there is an opened workspace, and multi root workspace support is enabled.
+     * @returns {boolean}
+     */
+    get isMultiRootWorkspaceEnabled(): boolean {
         return this.opened && this.preferences['workspace.supportMultiRootWorkspace'];
     }