@theia/preferences 1.34.1 → 1.34.3

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

@@ -1,236 +1,236 @@
-// *****************************************************************************
-// Copyright (C) 2019 Ericsson and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
-// *****************************************************************************
-
-/* eslint-disable @typescript-eslint/no-explicit-any */
-
-import { inject, injectable, postConstruct } from '@theia/core/shared/inversify';
-import URI from '@theia/core/lib/common/uri';
-import { PreferenceProvider, PreferenceResolveResult } from '@theia/core/lib/browser/preferences/preference-provider';
-import { WorkspaceService } from '@theia/workspace/lib/browser/workspace-service';
-import { PreferenceConfigurations } from '@theia/core/lib/browser/preferences/preference-configurations';
-import { FolderPreferenceProvider, FolderPreferenceProviderFactory } from './folder-preference-provider';
-import { FileStat } from '@theia/filesystem/lib/common/files';
-
-@injectable()
-export class FoldersPreferencesProvider extends PreferenceProvider {
-
-    @inject(WorkspaceService)
-    protected readonly workspaceService: WorkspaceService;
-
-    @inject(FolderPreferenceProviderFactory)
-    protected readonly folderPreferenceProviderFactory: FolderPreferenceProviderFactory;
-
-    @inject(PreferenceConfigurations)
-    protected readonly configurations: PreferenceConfigurations;
-
-    protected readonly providers = new Map<string, FolderPreferenceProvider>();
-
-    @postConstruct()
-    protected async init(): Promise<void> {
-        await this.workspaceService.roots;
-
-        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)));
-        }
-        Promise.all(readyPromises).then(() => this._ready.resolve());
-    }
-
-    protected updateProviders(): void {
-        const roots = this.workspaceService.tryGetRoots();
-        const toDelete = new Set(this.providers.keys());
-        for (const folder of roots) {
-            for (const configPath of this.configurations.getPaths()) {
-                for (const configName of [...this.configurations.getSectionNames(), this.configurations.getConfigName()]) {
-                    const sectionUri = this.configurations.createUri(folder.resource, configPath, configName);
-                    const sectionKey = sectionUri.toString();
-                    toDelete.delete(sectionKey);
-                    if (!this.providers.has(sectionKey)) {
-                        const provider = this.createProvider(sectionUri, configName, folder);
-                        this.providers.set(sectionKey, provider);
-                    }
-                }
-            }
-        }
-        for (const key of toDelete) {
-            const provider = this.providers.get(key);
-            if (provider) {
-                this.providers.delete(key);
-                provider.dispose();
-            }
-        }
-    }
-
-    override getConfigUri(resourceUri?: string, sectionName: string = this.configurations.getConfigName()): URI | undefined {
-        for (const provider of this.getFolderProviders(resourceUri)) {
-            const configUri = provider.getConfigUri(resourceUri);
-            if (configUri && this.configurations.getName(configUri) === sectionName) {
-                return configUri;
-            }
-        }
-        return undefined;
-    }
-
-    override getContainingConfigUri(resourceUri?: string, sectionName: string = this.configurations.getConfigName()): URI | undefined {
-        for (const provider of this.getFolderProviders(resourceUri)) {
-            const configUri = provider.getConfigUri();
-            if (provider.contains(resourceUri) && this.configurations.getName(configUri) === sectionName) {
-                return configUri;
-            }
-        }
-        return undefined;
-    }
-
-    override getDomain(): string[] {
-        return this.workspaceService.tryGetRoots().map(root => root.resource.toString());
-    }
-
-    override resolve<T>(preferenceName: string, resourceUri?: string): PreferenceResolveResult<T> {
-        const result: PreferenceResolveResult<T> = {};
-        const groups = this.groupProvidersByConfigName(resourceUri);
-        for (const group of groups.values()) {
-            for (const provider of group) {
-                const { value, configUri } = provider.resolve<T>(preferenceName, resourceUri);
-                if (configUri && value !== undefined) {
-                    result.configUri = configUri;
-                    result.value = PreferenceProvider.merge(result.value as any, value as any) as any;
-                    break;
-                }
-            }
-        }
-        return result;
-    }
-
-    getPreferences(resourceUri?: string): { [p: string]: any } {
-        let result = {};
-        const groups = this.groupProvidersByConfigName(resourceUri);
-        for (const group of groups.values()) {
-            for (const provider of group) {
-                if (provider.getConfigUri(resourceUri)) {
-                    const preferences = provider.getPreferences();
-                    result = PreferenceProvider.merge(result, preferences) as any;
-                    break;
-                }
-            }
-        }
-        return result;
-    }
-
-    async setPreference(preferenceName: string, value: any, resourceUri?: string): Promise<boolean> {
-        const firstPathFragment = preferenceName.split('.', 1)[0];
-        const defaultConfigName = this.configurations.getConfigName();
-        const configName = this.configurations.isSectionName(firstPathFragment) ? firstPathFragment : defaultConfigName;
-
-        const providers = this.getFolderProviders(resourceUri);
-        let configPath: string | undefined;
-        const candidates = providers.filter(provider => {
-            // Attempt to figure out the settings folder (.vscode or .theia) we're interested in.
-            const containingConfigUri = provider.getConfigUri(resourceUri);
-            if (configPath === undefined && containingConfigUri) {
-                configPath = this.configurations.getPath(containingConfigUri);
-            }
-            const providerName = this.configurations.getName(containingConfigUri ?? provider.getConfigUri());
-            return providerName === configName || providerName === defaultConfigName;
-        });
-
-        const configNameAndPathMatches = [];
-        const configNameOnlyMatches = [];
-        const configUriMatches = [];
-        const otherMatches = [];
-
-        for (const candidate of candidates) {
-            const domainMatches = candidate.getConfigUri(resourceUri);
-            const configUri = domainMatches ?? candidate.getConfigUri();
-            const nameMatches = this.configurations.getName(configUri) === configName;
-            const pathMatches = this.configurations.getPath(configUri) === configPath;
-
-            // Perfect match, run immediately in case we can bail out early.
-            if (nameMatches && domainMatches) {
-                if (await candidate.setPreference(preferenceName, value, resourceUri)) {
-                    return true;
-                }
-            } else if (nameMatches && pathMatches) { // Right file in the right folder.
-                configNameAndPathMatches.push(candidate);
-            } else if (nameMatches) { // Right file.
-                configNameOnlyMatches.push(candidate);
-            } else if (domainMatches) { // Currently valid and governs target URI
-                configUriMatches.push(candidate);
-            } else {
-                otherMatches.push(candidate);
-            }
-        }
-
-        const candidateSets = [configNameAndPathMatches, configNameOnlyMatches, configUriMatches, otherMatches];
-
-        for (const candidateSet of candidateSets) {
-            for (const candidate of candidateSet) {
-                if (await candidate.setPreference(preferenceName, value, resourceUri)) {
-                    return true;
-                }
-            }
-        }
-
-        return false;
-    }
-
-    protected groupProvidersByConfigName(resourceUri?: string): Map<string, FolderPreferenceProvider[]> {
-        const groups = new Map<string, FolderPreferenceProvider[]>();
-        const providers = this.getFolderProviders(resourceUri);
-        for (const configName of [this.configurations.getConfigName(), ...this.configurations.getSectionNames()]) {
-            const group = [];
-            for (const provider of providers) {
-                if (this.configurations.getName(provider.getConfigUri()) === configName) {
-                    group.push(provider);
-                }
-            }
-            groups.set(configName, group);
-        }
-        return groups;
-    }
-
-    protected getFolderProviders(resourceUri?: string): FolderPreferenceProvider[] {
-        if (!resourceUri) {
-            return [];
-        }
-        const resourcePath = new URI(resourceUri).path;
-        let folder: Readonly<{ relativity: number, uri?: string }> = { relativity: Number.MAX_SAFE_INTEGER };
-        const providers = new Map<string, FolderPreferenceProvider[]>();
-        for (const provider of this.providers.values()) {
-            const uri = provider.folderUri.toString();
-            const folderProviders = (providers.get(uri) || []);
-            folderProviders.push(provider);
-            providers.set(uri, folderProviders);
-
-            // in case we have nested folders mounted as workspace roots, select the innermost enclosing folder
-            const relativity = provider.folderUri.path.relativity(resourcePath);
-            if (relativity >= 0 && folder.relativity > relativity) {
-                folder = { relativity, uri };
-            }
-        }
-        return folder.uri && providers.get(folder.uri) || [];
-    }
-
-    protected createProvider(uri: URI, section: string, folder: FileStat): FolderPreferenceProvider {
-        const provider = this.folderPreferenceProviderFactory(uri, section, folder);
-        this.toDispose.push(provider);
-        this.toDispose.push(provider.onDidPreferencesChanged(change => this.onDidPreferencesChangedEmitter.fire(change)));
-        return provider;
-    }
-
-}
+// *****************************************************************************
+// Copyright (C) 2019 Ericsson and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+// *****************************************************************************
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+import { inject, injectable, postConstruct } from '@theia/core/shared/inversify';
+import URI from '@theia/core/lib/common/uri';
+import { PreferenceProvider, PreferenceResolveResult } from '@theia/core/lib/browser/preferences/preference-provider';
+import { WorkspaceService } from '@theia/workspace/lib/browser/workspace-service';
+import { PreferenceConfigurations } from '@theia/core/lib/browser/preferences/preference-configurations';
+import { FolderPreferenceProvider, FolderPreferenceProviderFactory } from './folder-preference-provider';
+import { FileStat } from '@theia/filesystem/lib/common/files';
+
+@injectable()
+export class FoldersPreferencesProvider extends PreferenceProvider {
+
+    @inject(WorkspaceService)
+    protected readonly workspaceService: WorkspaceService;
+
+    @inject(FolderPreferenceProviderFactory)
+    protected readonly folderPreferenceProviderFactory: FolderPreferenceProviderFactory;
+
+    @inject(PreferenceConfigurations)
+    protected readonly configurations: PreferenceConfigurations;
+
+    protected readonly providers = new Map<string, FolderPreferenceProvider>();
+
+    @postConstruct()
+    protected async init(): Promise<void> {
+        await this.workspaceService.roots;
+
+        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)));
+        }
+        Promise.all(readyPromises).then(() => this._ready.resolve());
+    }
+
+    protected updateProviders(): void {
+        const roots = this.workspaceService.tryGetRoots();
+        const toDelete = new Set(this.providers.keys());
+        for (const folder of roots) {
+            for (const configPath of this.configurations.getPaths()) {
+                for (const configName of [...this.configurations.getSectionNames(), this.configurations.getConfigName()]) {
+                    const sectionUri = this.configurations.createUri(folder.resource, configPath, configName);
+                    const sectionKey = sectionUri.toString();
+                    toDelete.delete(sectionKey);
+                    if (!this.providers.has(sectionKey)) {
+                        const provider = this.createProvider(sectionUri, configName, folder);
+                        this.providers.set(sectionKey, provider);
+                    }
+                }
+            }
+        }
+        for (const key of toDelete) {
+            const provider = this.providers.get(key);
+            if (provider) {
+                this.providers.delete(key);
+                provider.dispose();
+            }
+        }
+    }
+
+    override getConfigUri(resourceUri?: string, sectionName: string = this.configurations.getConfigName()): URI | undefined {
+        for (const provider of this.getFolderProviders(resourceUri)) {
+            const configUri = provider.getConfigUri(resourceUri);
+            if (configUri && this.configurations.getName(configUri) === sectionName) {
+                return configUri;
+            }
+        }
+        return undefined;
+    }
+
+    override getContainingConfigUri(resourceUri?: string, sectionName: string = this.configurations.getConfigName()): URI | undefined {
+        for (const provider of this.getFolderProviders(resourceUri)) {
+            const configUri = provider.getConfigUri();
+            if (provider.contains(resourceUri) && this.configurations.getName(configUri) === sectionName) {
+                return configUri;
+            }
+        }
+        return undefined;
+    }
+
+    override getDomain(): string[] {
+        return this.workspaceService.tryGetRoots().map(root => root.resource.toString());
+    }
+
+    override resolve<T>(preferenceName: string, resourceUri?: string): PreferenceResolveResult<T> {
+        const result: PreferenceResolveResult<T> = {};
+        const groups = this.groupProvidersByConfigName(resourceUri);
+        for (const group of groups.values()) {
+            for (const provider of group) {
+                const { value, configUri } = provider.resolve<T>(preferenceName, resourceUri);
+                if (configUri && value !== undefined) {
+                    result.configUri = configUri;
+                    result.value = PreferenceProvider.merge(result.value as any, value as any) as any;
+                    break;
+                }
+            }
+        }
+        return result;
+    }
+
+    getPreferences(resourceUri?: string): { [p: string]: any } {
+        let result = {};
+        const groups = this.groupProvidersByConfigName(resourceUri);
+        for (const group of groups.values()) {
+            for (const provider of group) {
+                if (provider.getConfigUri(resourceUri)) {
+                    const preferences = provider.getPreferences();
+                    result = PreferenceProvider.merge(result, preferences) as any;
+                    break;
+                }
+            }
+        }
+        return result;
+    }
+
+    async setPreference(preferenceName: string, value: any, resourceUri?: string): Promise<boolean> {
+        const firstPathFragment = preferenceName.split('.', 1)[0];
+        const defaultConfigName = this.configurations.getConfigName();
+        const configName = this.configurations.isSectionName(firstPathFragment) ? firstPathFragment : defaultConfigName;
+
+        const providers = this.getFolderProviders(resourceUri);
+        let configPath: string | undefined;
+        const candidates = providers.filter(provider => {
+            // Attempt to figure out the settings folder (.vscode or .theia) we're interested in.
+            const containingConfigUri = provider.getConfigUri(resourceUri);
+            if (configPath === undefined && containingConfigUri) {
+                configPath = this.configurations.getPath(containingConfigUri);
+            }
+            const providerName = this.configurations.getName(containingConfigUri ?? provider.getConfigUri());
+            return providerName === configName || providerName === defaultConfigName;
+        });
+
+        const configNameAndPathMatches = [];
+        const configNameOnlyMatches = [];
+        const configUriMatches = [];
+        const otherMatches = [];
+
+        for (const candidate of candidates) {
+            const domainMatches = candidate.getConfigUri(resourceUri);
+            const configUri = domainMatches ?? candidate.getConfigUri();
+            const nameMatches = this.configurations.getName(configUri) === configName;
+            const pathMatches = this.configurations.getPath(configUri) === configPath;
+
+            // Perfect match, run immediately in case we can bail out early.
+            if (nameMatches && domainMatches) {
+                if (await candidate.setPreference(preferenceName, value, resourceUri)) {
+                    return true;
+                }
+            } else if (nameMatches && pathMatches) { // Right file in the right folder.
+                configNameAndPathMatches.push(candidate);
+            } else if (nameMatches) { // Right file.
+                configNameOnlyMatches.push(candidate);
+            } else if (domainMatches) { // Currently valid and governs target URI
+                configUriMatches.push(candidate);
+            } else {
+                otherMatches.push(candidate);
+            }
+        }
+
+        const candidateSets = [configNameAndPathMatches, configNameOnlyMatches, configUriMatches, otherMatches];
+
+        for (const candidateSet of candidateSets) {
+            for (const candidate of candidateSet) {
+                if (await candidate.setPreference(preferenceName, value, resourceUri)) {
+                    return true;
+                }
+            }
+        }
+
+        return false;
+    }
+
+    protected groupProvidersByConfigName(resourceUri?: string): Map<string, FolderPreferenceProvider[]> {
+        const groups = new Map<string, FolderPreferenceProvider[]>();
+        const providers = this.getFolderProviders(resourceUri);
+        for (const configName of [this.configurations.getConfigName(), ...this.configurations.getSectionNames()]) {
+            const group = [];
+            for (const provider of providers) {
+                if (this.configurations.getName(provider.getConfigUri()) === configName) {
+                    group.push(provider);
+                }
+            }
+            groups.set(configName, group);
+        }
+        return groups;
+    }
+
+    protected getFolderProviders(resourceUri?: string): FolderPreferenceProvider[] {
+        if (!resourceUri) {
+            return [];
+        }
+        const resourcePath = new URI(resourceUri).path;
+        let folder: Readonly<{ relativity: number, uri?: string }> = { relativity: Number.MAX_SAFE_INTEGER };
+        const providers = new Map<string, FolderPreferenceProvider[]>();
+        for (const provider of this.providers.values()) {
+            const uri = provider.folderUri.toString();
+            const folderProviders = (providers.get(uri) || []);
+            folderProviders.push(provider);
+            providers.set(uri, folderProviders);
+
+            // in case we have nested folders mounted as workspace roots, select the innermost enclosing folder
+            const relativity = provider.folderUri.path.relativity(resourcePath);
+            if (relativity >= 0 && folder.relativity > relativity) {
+                folder = { relativity, uri };
+            }
+        }
+        return folder.uri && providers.get(folder.uri) || [];
+    }
+
+    protected createProvider(uri: URI, section: string, folder: FileStat): FolderPreferenceProvider {
+        const provider = this.folderPreferenceProviderFactory(uri, section, folder);
+        this.toDispose.push(provider);
+        this.toDispose.push(provider.onDidPreferencesChanged(change => this.onDidPreferencesChangedEmitter.fire(change)));
+        return provider;
+    }
+
+}

package/src/browser/index.ts

@@ -1,23 +1,23 @@
-// *****************************************************************************
-// Copyright (C) 2018 Ericsson and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
-// *****************************************************************************
-
-export * from '@theia/core/lib/browser/preferences';
-export * from './abstract-resource-preference-provider';
-export * from './user-preference-provider';
-export * from './workspace-preference-provider';
-export * from './folders-preferences-provider';
-export * from './folder-preference-provider';
-export * from './user-configs-preference-provider';
+// *****************************************************************************
+// Copyright (C) 2018 Ericsson and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+// *****************************************************************************
+
+export * from '@theia/core/lib/browser/preferences';
+export * from './abstract-resource-preference-provider';
+export * from './user-preference-provider';
+export * from './workspace-preference-provider';
+export * from './folders-preferences-provider';
+export * from './folder-preference-provider';
+export * from './user-configs-preference-provider';