@theia/preferences 1.45.1 → 1.46.0-next.72

package/src/browser/user-configs-preference-provider.ts

@@ -1,127 +1,127 @@
-// *****************************************************************************
-// 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-only 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 { PreferenceConfigurations } from '@theia/core/lib/browser/preferences/preference-configurations';
-import { UserStorageUri } from '@theia/userstorage/lib/browser';
-import { UserPreferenceProvider, UserPreferenceProviderFactory } from './user-preference-provider';
-
-/**
- * Binds together preference section prefs providers for user-level preferences.
- */
-@injectable()
-export class UserConfigsPreferenceProvider extends PreferenceProvider {
-
-    @inject(UserPreferenceProviderFactory)
-    protected readonly providerFactory: UserPreferenceProviderFactory;
-
-    @inject(PreferenceConfigurations)
-    protected readonly configurations: PreferenceConfigurations;
-
-    protected readonly providers = new Map<string, UserPreferenceProvider>();
-
-    @postConstruct()
-    protected init(): void {
-        this.doInit();
-    }
-
-    protected async doInit(): Promise<void> {
-        this.createProviders();
-
-        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 createProviders(): void {
-        for (const configName of [...this.configurations.getSectionNames(), this.configurations.getConfigName()]) {
-            const sectionUri = UserStorageUri.resolve(configName + '.json');
-            const sectionKey = sectionUri.toString();
-            if (!this.providers.has(sectionKey)) {
-                const provider = this.createProvider(sectionUri, configName);
-                this.providers.set(sectionKey, provider);
-            }
-        }
-    }
-
-    override getConfigUri(resourceUri?: string, sectionName: string = this.configurations.getConfigName()): URI | undefined {
-        for (const provider of this.providers.values()) {
-            const configUri = provider.getConfigUri(resourceUri);
-            if (configUri && this.configurations.getName(configUri) === sectionName) {
-                return configUri;
-            }
-        }
-        return undefined;
-    }
-
-    override resolve<T>(preferenceName: string, resourceUri?: string): PreferenceResolveResult<T> {
-        const result: PreferenceResolveResult<T> = {};
-        for (const provider of this.providers.values()) {
-            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;
-            }
-        }
-        return result;
-    }
-
-    getPreferences(resourceUri?: string): { [p: string]: any } {
-        let result = {};
-        for (const provider of this.providers.values()) {
-            const preferences = provider.getPreferences();
-            result = PreferenceProvider.merge(result, preferences) as any;
-        }
-        return result;
-    }
-
-    async setPreference(preferenceName: string, value: any, resourceUri?: string): Promise<boolean> {
-        const sectionName = preferenceName.split('.', 1)[0];
-        const defaultConfigName = this.configurations.getConfigName();
-        const configName = this.configurations.isSectionName(sectionName) ? sectionName : defaultConfigName;
-
-        const setWithConfigName = async (name: string): Promise<boolean> => {
-            for (const provider of this.providers.values()) {
-                if (this.configurations.getName(provider.getConfigUri()) === name) {
-                    if (await provider.setPreference(preferenceName, value, resourceUri)) {
-                        return true;
-                    }
-                }
-            }
-            return false;
-        };
-
-        if (await setWithConfigName(configName)) { // Try in the section we believe it belongs in.
-            return true;
-        } else if (configName !== defaultConfigName) { // Fall back to `settings.json` if that fails.
-            return setWithConfigName(defaultConfigName);
-        }
-        return false;
-    }
-
-    protected createProvider(uri: URI, sectionName: string): UserPreferenceProvider {
-        const provider = this.providerFactory(uri, sectionName);
-        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-only 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 { PreferenceConfigurations } from '@theia/core/lib/browser/preferences/preference-configurations';
+import { UserStorageUri } from '@theia/userstorage/lib/browser';
+import { UserPreferenceProvider, UserPreferenceProviderFactory } from './user-preference-provider';
+
+/**
+ * Binds together preference section prefs providers for user-level preferences.
+ */
+@injectable()
+export class UserConfigsPreferenceProvider extends PreferenceProvider {
+
+    @inject(UserPreferenceProviderFactory)
+    protected readonly providerFactory: UserPreferenceProviderFactory;
+
+    @inject(PreferenceConfigurations)
+    protected readonly configurations: PreferenceConfigurations;
+
+    protected readonly providers = new Map<string, UserPreferenceProvider>();
+
+    @postConstruct()
+    protected init(): void {
+        this.doInit();
+    }
+
+    protected async doInit(): Promise<void> {
+        this.createProviders();
+
+        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 createProviders(): void {
+        for (const configName of [...this.configurations.getSectionNames(), this.configurations.getConfigName()]) {
+            const sectionUri = UserStorageUri.resolve(configName + '.json');
+            const sectionKey = sectionUri.toString();
+            if (!this.providers.has(sectionKey)) {
+                const provider = this.createProvider(sectionUri, configName);
+                this.providers.set(sectionKey, provider);
+            }
+        }
+    }
+
+    override getConfigUri(resourceUri?: string, sectionName: string = this.configurations.getConfigName()): URI | undefined {
+        for (const provider of this.providers.values()) {
+            const configUri = provider.getConfigUri(resourceUri);
+            if (configUri && this.configurations.getName(configUri) === sectionName) {
+                return configUri;
+            }
+        }
+        return undefined;
+    }
+
+    override resolve<T>(preferenceName: string, resourceUri?: string): PreferenceResolveResult<T> {
+        const result: PreferenceResolveResult<T> = {};
+        for (const provider of this.providers.values()) {
+            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;
+            }
+        }
+        return result;
+    }
+
+    getPreferences(resourceUri?: string): { [p: string]: any } {
+        let result = {};
+        for (const provider of this.providers.values()) {
+            const preferences = provider.getPreferences();
+            result = PreferenceProvider.merge(result, preferences) as any;
+        }
+        return result;
+    }
+
+    async setPreference(preferenceName: string, value: any, resourceUri?: string): Promise<boolean> {
+        const sectionName = preferenceName.split('.', 1)[0];
+        const defaultConfigName = this.configurations.getConfigName();
+        const configName = this.configurations.isSectionName(sectionName) ? sectionName : defaultConfigName;
+
+        const setWithConfigName = async (name: string): Promise<boolean> => {
+            for (const provider of this.providers.values()) {
+                if (this.configurations.getName(provider.getConfigUri()) === name) {
+                    if (await provider.setPreference(preferenceName, value, resourceUri)) {
+                        return true;
+                    }
+                }
+            }
+            return false;
+        };
+
+        if (await setWithConfigName(configName)) { // Try in the section we believe it belongs in.
+            return true;
+        } else if (configName !== defaultConfigName) { // Fall back to `settings.json` if that fails.
+            return setWithConfigName(defaultConfigName);
+        }
+        return false;
+    }
+
+    protected createProvider(uri: URI, sectionName: string): UserPreferenceProvider {
+        const provider = this.providerFactory(uri, sectionName);
+        this.toDispose.push(provider);
+        this.toDispose.push(provider.onDidPreferencesChanged(change => this.onDidPreferencesChangedEmitter.fire(change)));
+        return provider;
+    }
+}

package/src/browser/user-preference-provider.ts

@@ -1,35 +1,35 @@
-// *****************************************************************************
-// 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-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import { injectable } from '@theia/core/shared/inversify';
-import URI from '@theia/core/lib/common/uri';
-import { PreferenceScope } from '@theia/core/lib/browser';
-import { SectionPreferenceProvider } from './section-preference-provider';
-
-export const UserPreferenceProviderFactory = Symbol('UserPreferenceProviderFactory');
-export interface UserPreferenceProviderFactory {
-    (uri: URI, section: string): UserPreferenceProvider;
-};
-
-/**
- * A @SectionPreferenceProvider that targets the user-level settings
- */
-@injectable()
-export class UserPreferenceProvider extends SectionPreferenceProvider {
-    getScope(): PreferenceScope {
-        return PreferenceScope.User;
-    }
-}
+// *****************************************************************************
+// 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-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { injectable } from '@theia/core/shared/inversify';
+import URI from '@theia/core/lib/common/uri';
+import { PreferenceScope } from '@theia/core/lib/browser';
+import { SectionPreferenceProvider } from './section-preference-provider';
+
+export const UserPreferenceProviderFactory = Symbol('UserPreferenceProviderFactory');
+export interface UserPreferenceProviderFactory {
+    (uri: URI, section: string): UserPreferenceProvider;
+};
+
+/**
+ * A @SectionPreferenceProvider that targets the user-level settings
+ */
+@injectable()
+export class UserPreferenceProvider extends SectionPreferenceProvider {
+    getScope(): PreferenceScope {
+        return PreferenceScope.User;
+    }
+}

package/src/browser/util/preference-scope-command-manager.ts

@@ -1,75 +1,75 @@
-// *****************************************************************************
-// Copyright (C) 2018 Red Hat, Inc. 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-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import { injectable, inject } from '@theia/core/shared/inversify';
-import { PreferenceScope, LabelProvider, codicon } from '@theia/core/lib/browser';
-import { FileStat } from '@theia/filesystem/lib/common/files';
-import { CommandRegistry, MenuModelRegistry, Command } from '@theia/core/lib/common';
-import { Preference, PreferenceMenus } from './preference-types';
-
-/**
- * @deprecated since 1.17.0 moved to PreferenceMenus namespace.
- */
-export const FOLDER_SCOPE_MENU_PATH = PreferenceMenus.FOLDER_SCOPE_MENU_PATH;
-
-/**
- * @deprecated since 1.17.0. This work is now done in the PreferenceScopeTabbarWidget.
- */
-@injectable()
-export class PreferenceScopeCommandManager {
-    @inject(CommandRegistry) protected readonly commandRegistry: CommandRegistry;
-    @inject(MenuModelRegistry) protected readonly menuModelRegistry: MenuModelRegistry;
-    @inject(LabelProvider) protected readonly labelProvider: LabelProvider;
-
-    protected foldersAsCommands: Command[] = [];
-
-    createFolderWorkspacesMenu(
-        folderWorkspaces: FileStat[],
-        currentFolderURI?: string,
-    ): void {
-        this.foldersAsCommands.forEach(folderCommand => {
-            this.menuModelRegistry.unregisterMenuAction(folderCommand, FOLDER_SCOPE_MENU_PATH);
-            this.commandRegistry.unregisterCommand(folderCommand);
-        });
-        this.foldersAsCommands.length = 0;
-
-        folderWorkspaces.forEach(folderWorkspace => {
-            const folderLabel = this.labelProvider.getName(folderWorkspace.resource);
-
-            const iconClass = currentFolderURI === folderWorkspace.resource.toString() ? codicon('pass') : '';
-            const newFolderAsCommand = {
-                id: `preferenceScopeCommand:${folderWorkspace.resource.toString()}`,
-                label: folderLabel,
-                iconClass: iconClass
-            };
-
-            this.foldersAsCommands.push(newFolderAsCommand);
-
-            this.commandRegistry.registerCommand(newFolderAsCommand, {
-                isVisible: (callback, check) => check === 'from-tabbar',
-                isEnabled: (callback, check) => check === 'from-tabbar',
-                execute: (callback: (scopeDetails: Preference.SelectedScopeDetails) => void) => {
-                    callback({ scope: PreferenceScope.Folder, uri: folderWorkspace.resource.toString(), activeScopeIsFolder: true });
-                }
-            });
-
-            this.menuModelRegistry.registerMenuAction(FOLDER_SCOPE_MENU_PATH, {
-                commandId: newFolderAsCommand.id,
-                label: newFolderAsCommand.label
-            });
-        });
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2018 Red Hat, Inc. 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-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { injectable, inject } from '@theia/core/shared/inversify';
+import { PreferenceScope, LabelProvider, codicon } from '@theia/core/lib/browser';
+import { FileStat } from '@theia/filesystem/lib/common/files';
+import { CommandRegistry, MenuModelRegistry, Command } from '@theia/core/lib/common';
+import { Preference, PreferenceMenus } from './preference-types';
+
+/**
+ * @deprecated since 1.17.0 moved to PreferenceMenus namespace.
+ */
+export const FOLDER_SCOPE_MENU_PATH = PreferenceMenus.FOLDER_SCOPE_MENU_PATH;
+
+/**
+ * @deprecated since 1.17.0. This work is now done in the PreferenceScopeTabbarWidget.
+ */
+@injectable()
+export class PreferenceScopeCommandManager {
+    @inject(CommandRegistry) protected readonly commandRegistry: CommandRegistry;
+    @inject(MenuModelRegistry) protected readonly menuModelRegistry: MenuModelRegistry;
+    @inject(LabelProvider) protected readonly labelProvider: LabelProvider;
+
+    protected foldersAsCommands: Command[] = [];
+
+    createFolderWorkspacesMenu(
+        folderWorkspaces: FileStat[],
+        currentFolderURI?: string,
+    ): void {
+        this.foldersAsCommands.forEach(folderCommand => {
+            this.menuModelRegistry.unregisterMenuAction(folderCommand, FOLDER_SCOPE_MENU_PATH);
+            this.commandRegistry.unregisterCommand(folderCommand);
+        });
+        this.foldersAsCommands.length = 0;
+
+        folderWorkspaces.forEach(folderWorkspace => {
+            const folderLabel = this.labelProvider.getName(folderWorkspace.resource);
+
+            const iconClass = currentFolderURI === folderWorkspace.resource.toString() ? codicon('pass') : '';
+            const newFolderAsCommand = {
+                id: `preferenceScopeCommand:${folderWorkspace.resource.toString()}`,
+                label: folderLabel,
+                iconClass: iconClass
+            };
+
+            this.foldersAsCommands.push(newFolderAsCommand);
+
+            this.commandRegistry.registerCommand(newFolderAsCommand, {
+                isVisible: (callback, check) => check === 'from-tabbar',
+                isEnabled: (callback, check) => check === 'from-tabbar',
+                execute: (callback: (scopeDetails: Preference.SelectedScopeDetails) => void) => {
+                    callback({ scope: PreferenceScope.Folder, uri: folderWorkspace.resource.toString(), activeScopeIsFolder: true });
+                }
+            });
+
+            this.menuModelRegistry.registerMenuAction(FOLDER_SCOPE_MENU_PATH, {
+                commandId: newFolderAsCommand.id,
+                label: newFolderAsCommand.label
+            });
+        });
+    }
+}