@theia/preferences 1.45.0 → 1.46.0-next.72

package/src/browser/preferences-json-schema-contribution.ts

@@ -1,86 +1,86 @@
-// *****************************************************************************
-// Copyright (C) 2018 TypeFox 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 { inject, injectable } from '@theia/core/shared/inversify';
-import URI from '@theia/core/lib/common/uri';
-import { InMemoryResources } from '@theia/core';
-import { JsonSchemaRegisterContext, JsonSchemaContribution } from '@theia/core/lib/browser/json-schema-store';
-import { PreferenceSchemaProvider } from '@theia/core/lib/browser/preferences/preference-contribution';
-import { PreferenceConfigurations } from '@theia/core/lib/browser/preferences/preference-configurations';
-import { PreferenceScope } from '@theia/core/lib/browser';
-import { WorkspaceService } from '@theia/workspace/lib/browser';
-
-const PREFERENCE_URI_PREFIX = 'vscode://schemas/settings/';
-const USER_STORAGE_PREFIX = 'user-storage:/';
-
-@injectable()
-export class PreferencesJsonSchemaContribution implements JsonSchemaContribution {
-    private serializeSchema = (scope: PreferenceScope) => JSON.stringify(this.schemaProvider.getSchema(scope));
-
-    @inject(PreferenceSchemaProvider)
-    protected readonly schemaProvider: PreferenceSchemaProvider;
-
-    @inject(InMemoryResources)
-    protected readonly inmemoryResources: InMemoryResources;
-
-    @inject(PreferenceConfigurations)
-    protected readonly preferenceConfigurations: PreferenceConfigurations;
-
-    @inject(WorkspaceService)
-    protected readonly workspaceService: WorkspaceService;
-
-    registerSchemas(context: JsonSchemaRegisterContext): void {
-        this.registerSchema(PreferenceScope.Default, context);
-        this.registerSchema(PreferenceScope.User, context);
-        this.registerSchema(PreferenceScope.Workspace, context);
-        this.registerSchema(PreferenceScope.Folder, context);
-
-        this.workspaceService.updateSchema('settings', { $ref: this.getSchemaURIForScope(PreferenceScope.Workspace).toString() });
-        this.schemaProvider.onDidPreferenceSchemaChanged(() => this.updateInMemoryResources());
-    }
-
-    private registerSchema(scope: PreferenceScope, context: JsonSchemaRegisterContext): void {
-        const scopeStr = PreferenceScope[scope].toLowerCase();
-        const uri = new URI(PREFERENCE_URI_PREFIX + scopeStr);
-
-        this.inmemoryResources.add(uri, this.serializeSchema(scope));
-
-        context.registerSchema({
-            fileMatch: this.getFileMatch(scopeStr),
-            url: uri.toString()
-        });
-    }
-
-    private updateInMemoryResources(): void {
-        this.inmemoryResources.update(this.getSchemaURIForScope(PreferenceScope.Default),
-            this.serializeSchema(+PreferenceScope.Default));
-        this.inmemoryResources.update(this.getSchemaURIForScope(PreferenceScope.User),
-            this.serializeSchema(+PreferenceScope.User));
-        this.inmemoryResources.update(this.getSchemaURIForScope(PreferenceScope.Workspace),
-            this.serializeSchema(+PreferenceScope.Workspace));
-        this.inmemoryResources.update(this.getSchemaURIForScope(PreferenceScope.Folder),
-            this.serializeSchema(+PreferenceScope.Folder));
-    }
-
-    private getSchemaURIForScope(scope: PreferenceScope): URI {
-        return new URI(PREFERENCE_URI_PREFIX + PreferenceScope[scope].toLowerCase());
-    }
-
-    private getFileMatch(scope: string): string[] {
-        const baseName = this.preferenceConfigurations.getConfigName() + '.json';
-        return [baseName, new URI(USER_STORAGE_PREFIX + scope).resolve(baseName).toString()];
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2018 TypeFox 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 { inject, injectable } from '@theia/core/shared/inversify';
+import URI from '@theia/core/lib/common/uri';
+import { InMemoryResources } from '@theia/core';
+import { JsonSchemaRegisterContext, JsonSchemaContribution } from '@theia/core/lib/browser/json-schema-store';
+import { PreferenceSchemaProvider } from '@theia/core/lib/browser/preferences/preference-contribution';
+import { PreferenceConfigurations } from '@theia/core/lib/browser/preferences/preference-configurations';
+import { PreferenceScope } from '@theia/core/lib/browser';
+import { WorkspaceService } from '@theia/workspace/lib/browser';
+
+const PREFERENCE_URI_PREFIX = 'vscode://schemas/settings/';
+const USER_STORAGE_PREFIX = 'user-storage:/';
+
+@injectable()
+export class PreferencesJsonSchemaContribution implements JsonSchemaContribution {
+    private serializeSchema = (scope: PreferenceScope) => JSON.stringify(this.schemaProvider.getSchema(scope));
+
+    @inject(PreferenceSchemaProvider)
+    protected readonly schemaProvider: PreferenceSchemaProvider;
+
+    @inject(InMemoryResources)
+    protected readonly inmemoryResources: InMemoryResources;
+
+    @inject(PreferenceConfigurations)
+    protected readonly preferenceConfigurations: PreferenceConfigurations;
+
+    @inject(WorkspaceService)
+    protected readonly workspaceService: WorkspaceService;
+
+    registerSchemas(context: JsonSchemaRegisterContext): void {
+        this.registerSchema(PreferenceScope.Default, context);
+        this.registerSchema(PreferenceScope.User, context);
+        this.registerSchema(PreferenceScope.Workspace, context);
+        this.registerSchema(PreferenceScope.Folder, context);
+
+        this.workspaceService.updateSchema('settings', { $ref: this.getSchemaURIForScope(PreferenceScope.Workspace).toString() });
+        this.schemaProvider.onDidPreferenceSchemaChanged(() => this.updateInMemoryResources());
+    }
+
+    private registerSchema(scope: PreferenceScope, context: JsonSchemaRegisterContext): void {
+        const scopeStr = PreferenceScope[scope].toLowerCase();
+        const uri = new URI(PREFERENCE_URI_PREFIX + scopeStr);
+
+        this.inmemoryResources.add(uri, this.serializeSchema(scope));
+
+        context.registerSchema({
+            fileMatch: this.getFileMatch(scopeStr),
+            url: uri.toString()
+        });
+    }
+
+    private updateInMemoryResources(): void {
+        this.inmemoryResources.update(this.getSchemaURIForScope(PreferenceScope.Default),
+            this.serializeSchema(+PreferenceScope.Default));
+        this.inmemoryResources.update(this.getSchemaURIForScope(PreferenceScope.User),
+            this.serializeSchema(+PreferenceScope.User));
+        this.inmemoryResources.update(this.getSchemaURIForScope(PreferenceScope.Workspace),
+            this.serializeSchema(+PreferenceScope.Workspace));
+        this.inmemoryResources.update(this.getSchemaURIForScope(PreferenceScope.Folder),
+            this.serializeSchema(+PreferenceScope.Folder));
+    }
+
+    private getSchemaURIForScope(scope: PreferenceScope): URI {
+        return new URI(PREFERENCE_URI_PREFIX + PreferenceScope[scope].toLowerCase());
+    }
+
+    private getFileMatch(scope: string): string[] {
+        const baseName = this.preferenceConfigurations.getConfigName() + '.json';
+        return [baseName, new URI(USER_STORAGE_PREFIX + scope).resolve(baseName).toString()];
+    }
+}

package/src/browser/preferences-monaco-contribution.ts

@@ -1,27 +1,27 @@
-// *****************************************************************************
-// Copyright (C) 2018 TypeFox 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 * as monaco from '@theia/monaco-editor-core';
-
-monaco.languages.register({
-    id: 'jsonc',
-    'aliases': [
-        'JSON with Comments'
-    ],
-    'filenames': [
-        'settings.json'
-    ]
-});
+// *****************************************************************************
+// Copyright (C) 2018 TypeFox 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 * as monaco from '@theia/monaco-editor-core';
+
+monaco.languages.register({
+    id: 'jsonc',
+    'aliases': [
+        'JSON with Comments'
+    ],
+    'filenames': [
+        'settings.json'
+    ]
+});

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

@@ -1,83 +1,83 @@
-// *****************************************************************************
-// 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
-// *****************************************************************************
-
-import { inject, injectable } from '@theia/core/shared/inversify';
-import URI from '@theia/core/lib/common/uri';
-import { AbstractResourcePreferenceProvider } from './abstract-resource-preference-provider';
-import { WorkspaceService } from '@theia/workspace/lib/browser/workspace-service';
-import { PreferenceConfigurations } from '@theia/core/lib/browser/preferences/preference-configurations';
-
-export const SectionPreferenceProviderUri = Symbol('SectionPreferenceProviderUri');
-export const SectionPreferenceProviderSection = Symbol('SectionPreferenceProviderSection');
-
-/**
- * This class encapsulates the logic of using separate files for some workspace configuration like 'launch.json' or 'tasks.json'.
- * Anything that is not a contributed section will be in the main config file.
- */
-@injectable()
-export abstract class SectionPreferenceProvider extends AbstractResourcePreferenceProvider {
-
-    @inject(WorkspaceService)
-    protected readonly workspaceService: WorkspaceService;
-    @inject(SectionPreferenceProviderUri)
-    protected readonly uri: URI;
-    @inject(SectionPreferenceProviderSection)
-    protected readonly section: string;
-    @inject(PreferenceConfigurations)
-    protected readonly preferenceConfigurations: PreferenceConfigurations;
-
-    private _isSection?: boolean;
-
-    private get isSection(): boolean {
-        if (typeof this._isSection === 'undefined') {
-            this._isSection = this.preferenceConfigurations.isSectionName(this.section);
-        }
-        return this._isSection;
-    }
-
-    protected getUri(): URI {
-        return this.uri;
-    }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    protected override parse(content: string): any {
-        const prefs = super.parse(content);
-        if (this.isSection) {
-            if (prefs === undefined) {
-                return undefined;
-            }
-            const result: { [k: string]: unknown } = {
-
-            };
-            result[this.section] = { ...prefs };
-            return result;
-        } else {
-            return prefs;
-        }
-    }
-
-    protected override getPath(preferenceName: string): string[] | undefined {
-        if (!this.isSection) {
-            return super.getPath(preferenceName);
-        }
-        if (preferenceName === this.section) {
-            return [];
-        }
-        if (preferenceName.startsWith(`${this.section}.`)) {
-            return [preferenceName.slice(this.section.length + 1)];
-        }
-        return undefined;
-    }
-}
+// *****************************************************************************
+// 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
+// *****************************************************************************
+
+import { inject, injectable } from '@theia/core/shared/inversify';
+import URI from '@theia/core/lib/common/uri';
+import { AbstractResourcePreferenceProvider } from './abstract-resource-preference-provider';
+import { WorkspaceService } from '@theia/workspace/lib/browser/workspace-service';
+import { PreferenceConfigurations } from '@theia/core/lib/browser/preferences/preference-configurations';
+
+export const SectionPreferenceProviderUri = Symbol('SectionPreferenceProviderUri');
+export const SectionPreferenceProviderSection = Symbol('SectionPreferenceProviderSection');
+
+/**
+ * This class encapsulates the logic of using separate files for some workspace configuration like 'launch.json' or 'tasks.json'.
+ * Anything that is not a contributed section will be in the main config file.
+ */
+@injectable()
+export abstract class SectionPreferenceProvider extends AbstractResourcePreferenceProvider {
+
+    @inject(WorkspaceService)
+    protected readonly workspaceService: WorkspaceService;
+    @inject(SectionPreferenceProviderUri)
+    protected readonly uri: URI;
+    @inject(SectionPreferenceProviderSection)
+    protected readonly section: string;
+    @inject(PreferenceConfigurations)
+    protected readonly preferenceConfigurations: PreferenceConfigurations;
+
+    private _isSection?: boolean;
+
+    private get isSection(): boolean {
+        if (typeof this._isSection === 'undefined') {
+            this._isSection = this.preferenceConfigurations.isSectionName(this.section);
+        }
+        return this._isSection;
+    }
+
+    protected getUri(): URI {
+        return this.uri;
+    }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    protected override parse(content: string): any {
+        const prefs = super.parse(content);
+        if (this.isSection) {
+            if (prefs === undefined) {
+                return undefined;
+            }
+            const result: { [k: string]: unknown } = {
+
+            };
+            result[this.section] = { ...prefs };
+            return result;
+        } else {
+            return prefs;
+        }
+    }
+
+    protected override getPath(preferenceName: string): string[] | undefined {
+        if (!this.isSection) {
+            return super.getPath(preferenceName);
+        }
+        if (preferenceName === this.section) {
+            return [];
+        }
+        if (preferenceName.startsWith(`${this.section}.`)) {
+            return [preferenceName.slice(this.section.length + 1)];
+        }
+        return undefined;
+    }
+}