@theia/preferences 1.53.0-next.55 → 1.53.0-next.64

package/README.md

@@ -1,81 +1,81 @@
-<div align='center'>
-
-<br />
-
-<img src='https://raw.githubusercontent.com/eclipse-theia/theia/master/logo/theia.svg?sanitize=true' alt='theia-ext-logo' width='100px' />
-
-<h2>ECLIPSE THEIA - PREFERENCES EXTENSION</h2>
-
-<hr />
-
-</div>
-
-## Description
-
-The `@theia/preferences` extension implements the preferences API defined in `@theia/core`, including the four preference providers:
-- `Default` Preference, which serves as default values of preferences,
-- `User` Preference for the user home directory, which has precedence over the default values,
-- `Workspace` Preference for the workspace, which has precedence over User Preference, and
-- `Folder` Preference for the root folder, which has precedence over the Workspace Preference
-
-To set:
-- `User` Preferences: Create or edit a `settings.json` under the `.theia` folder located either in the user home.
-- `Workspace` Preference: If one folder is opened as the workspace, create or edit a `settings.json` under the root of the workspace. If a multi-root workspace is opened, create or edit the "settings" property in the workspace file.
-- `Folder` Preferences: Create or edit a `settings.json` under any of the root folders.
-
-Example of a `settings.json` below:
-
-```typescript
-{
-    // Enable/Disable the line numbers in the monaco editor
-	"editor.lineNumbers": "off",
-    // Tab width in the editor
-	"editor.tabSize": 4,
-	"files.watcherExclude": "path/to/file"
-}
-```
-
-Example of a workspace file below:
-
-```typescript
-{
-   "folders": [
-      {
-         "path": "file:///home/username/helloworld"
-	  },
-	  {
-         "path": "file:///home/username/dev/byeworld"
-      }
-   ],
-   "settings": {
-      // Enable/Disable the line numbers in the monaco editor
-	  "editor.lineNumbers": "off",
-      // Tab width in the editor
-	  "editor.tabSize": 4,
-   }
-}
-```
-
-## Additional Information
-
-- [API documentation for `@theia/preferences`](https://eclipse-theia.github.io/theia/docs/next/modules/preferences.html)
-- [Theia - GitHub](https://github.com/eclipse-theia/theia)
-- [Theia - Website](https://theia-ide.org/)
-
-## License
-
-- [Eclipse Public License 2.0](http://www.eclipse.org/legal/epl-2.0/)
-- [一 (Secondary) GNU General Public License, version 2 with the GNU Classpath Exception](https://projects.eclipse.org/license/secondary-gpl-2.0-cp)
-
-## Trademark
-"Theia" is a trademark of the Eclipse Foundation
-https://www.eclipse.org/theia
-
-
-# Theia - Preferences Extension
-
-
-
-## License
-- [Eclipse Public License 2.0](http://www.eclipse.org/legal/epl-2.0/)
-- [一 (Secondary) GNU General Public License, version 2 with the GNU Classpath Exception](https://projects.eclipse.org/license/secondary-gpl-2.0-cp)
+<div align='center'>
+
+<br />
+
+<img src='https://raw.githubusercontent.com/eclipse-theia/theia/master/logo/theia.svg?sanitize=true' alt='theia-ext-logo' width='100px' />
+
+<h2>ECLIPSE THEIA - PREFERENCES EXTENSION</h2>
+
+<hr />
+
+</div>
+
+## Description
+
+The `@theia/preferences` extension implements the preferences API defined in `@theia/core`, including the four preference providers:
+- `Default` Preference, which serves as default values of preferences,
+- `User` Preference for the user home directory, which has precedence over the default values,
+- `Workspace` Preference for the workspace, which has precedence over User Preference, and
+- `Folder` Preference for the root folder, which has precedence over the Workspace Preference
+
+To set:
+- `User` Preferences: Create or edit a `settings.json` under the `.theia` folder located either in the user home.
+- `Workspace` Preference: If one folder is opened as the workspace, create or edit a `settings.json` under the root of the workspace. If a multi-root workspace is opened, create or edit the "settings" property in the workspace file.
+- `Folder` Preferences: Create or edit a `settings.json` under any of the root folders.
+
+Example of a `settings.json` below:
+
+```typescript
+{
+    // Enable/Disable the line numbers in the monaco editor
+	"editor.lineNumbers": "off",
+    // Tab width in the editor
+	"editor.tabSize": 4,
+	"files.watcherExclude": "path/to/file"
+}
+```
+
+Example of a workspace file below:
+
+```typescript
+{
+   "folders": [
+      {
+         "path": "file:///home/username/helloworld"
+	  },
+	  {
+         "path": "file:///home/username/dev/byeworld"
+      }
+   ],
+   "settings": {
+      // Enable/Disable the line numbers in the monaco editor
+	  "editor.lineNumbers": "off",
+      // Tab width in the editor
+	  "editor.tabSize": 4,
+   }
+}
+```
+
+## Additional Information
+
+- [API documentation for `@theia/preferences`](https://eclipse-theia.github.io/theia/docs/next/modules/preferences.html)
+- [Theia - GitHub](https://github.com/eclipse-theia/theia)
+- [Theia - Website](https://theia-ide.org/)
+
+## License
+
+- [Eclipse Public License 2.0](http://www.eclipse.org/legal/epl-2.0/)
+- [一 (Secondary) GNU General Public License, version 2 with the GNU Classpath Exception](https://projects.eclipse.org/license/secondary-gpl-2.0-cp)
+
+## Trademark
+"Theia" is a trademark of the Eclipse Foundation
+https://www.eclipse.org/theia
+
+
+# Theia - Preferences Extension
+
+
+
+## License
+- [Eclipse Public License 2.0](http://www.eclipse.org/legal/epl-2.0/)
+- [一 (Secondary) GNU General Public License, version 2 with the GNU Classpath Exception](https://projects.eclipse.org/license/secondary-gpl-2.0-cp)

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@theia/preferences",
-  "version": "1.53.0-next.55+d1a989a68c",
+  "version": "1.53.0-next.64+23b351d26",
   "description": "Theia - Preferences Extension",
   "dependencies": {
-    "@theia/core": "1.53.0-next.55+d1a989a68c",
-    "@theia/editor": "1.53.0-next.55+d1a989a68c",
-    "@theia/filesystem": "1.53.0-next.55+d1a989a68c",
-    "@theia/monaco": "1.53.0-next.55+d1a989a68c",
+    "@theia/core": "1.53.0-next.64+23b351d26",
+    "@theia/editor": "1.53.0-next.64+23b351d26",
+    "@theia/filesystem": "1.53.0-next.64+23b351d26",
+    "@theia/monaco": "1.53.0-next.64+23b351d26",
     "@theia/monaco-editor-core": "1.83.101",
-    "@theia/userstorage": "1.53.0-next.55+d1a989a68c",
-    "@theia/workspace": "1.53.0-next.55+d1a989a68c",
+    "@theia/userstorage": "1.53.0-next.64+23b351d26",
+    "@theia/workspace": "1.53.0-next.64+23b351d26",
     "async-mutex": "^0.3.1",
     "fast-deep-equal": "^3.1.3",
     "jsonc-parser": "^2.2.0",
@@ -55,5 +55,5 @@
   "nyc": {
     "extends": "../../configs/nyc.json"
   },
-  "gitHead": "d1a989a68c1b5ec1f9098e9126653c6346844769"
+  "gitHead": "23b351d26346a2b5d6aca3ee81fba59c056132f7"
 }

package/src/browser/abstract-resource-preference-provider.spec.ts

@@ -1,95 +1,95 @@
-// *****************************************************************************
-// Copyright (C) 2021 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 { enableJSDOM } from '@theia/core/lib/browser/test/jsdom';
-const disableJSDOM = enableJSDOM();
-
-import { FrontendApplicationConfigProvider } from '@theia/core/lib/browser/frontend-application-config-provider';
-FrontendApplicationConfigProvider.set({});
-
-import { expect } from 'chai';
-import { Container } from '@theia/core/shared/inversify';
-import { AbstractResourcePreferenceProvider } from './abstract-resource-preference-provider';
-import { FileService } from '@theia/filesystem/lib/browser/file-service';
-import { bindPreferenceService } from '@theia/core/lib/browser/frontend-application-bindings';
-import { bindMockPreferenceProviders } from '@theia/core/lib/browser/preferences/test';
-import { Deferred } from '@theia/core/lib/common/promise-util';
-import { Disposable, MessageService } from '@theia/core/lib/common';
-import { MonacoWorkspace } from '@theia/monaco/lib/browser/monaco-workspace';
-import { PreferenceSchemaProvider } from '@theia/core/lib/browser';
-import { EditorManager } from '@theia/editor/lib/browser';
-import { PreferenceTransactionFactory } from './preference-transaction-manager';
-
-disableJSDOM();
-
-class MockFileService {
-    releaseContent = new Deferred();
-    async read(): Promise<{ value: string }> {
-        await this.releaseContent.promise;
-        return { value: JSON.stringify({ 'editor.fontSize': 20 }) };
-    }
-    watch = RETURN_DISPOSABLE;
-    onDidFilesChange = RETURN_DISPOSABLE;
-}
-
-const RETURN_DISPOSABLE = () => Disposable.NULL;
-
-const mockSchemaProvider = { getCombinedSchema: () => ({ properties: {} }) };
-
-class LessAbstractPreferenceProvider extends AbstractResourcePreferenceProvider {
-    getUri(): any { }
-    getScope(): any { }
-}
-
-describe('AbstractResourcePreferenceProvider', () => {
-    let provider: AbstractResourcePreferenceProvider;
-    let fileService: MockFileService;
-
-    beforeEach(() => {
-        fileService = new MockFileService();
-        const testContainer = new Container();
-        bindPreferenceService(testContainer.bind.bind(testContainer));
-        bindMockPreferenceProviders(testContainer.bind.bind(testContainer), testContainer.unbind.bind(testContainer));
-        testContainer.rebind(<any>PreferenceSchemaProvider).toConstantValue(mockSchemaProvider);
-        testContainer.bind(<any>FileService).toConstantValue(fileService);
-        testContainer.bind(<any>MessageService).toConstantValue(undefined);
-        testContainer.bind(<any>MonacoWorkspace).toConstantValue(undefined);
-        testContainer.bind(<any>EditorManager).toConstantValue(undefined);
-        testContainer.bind(<any>PreferenceTransactionFactory).toConstantValue(undefined);
-        provider = testContainer.resolve(<any>LessAbstractPreferenceProvider);
-    });
-
-    it('should not store any preferences before it is ready.', async () => {
-        const resolveWhenFinished = new Deferred();
-        const errorIfReadyFirst = provider.ready.then(() => Promise.reject());
-
-        expect(provider.get('editor.fontSize')).to.be.undefined;
-
-        resolveWhenFinished.resolve();
-        fileService.releaseContent.resolve(); // Allow the initialization to run
-
-        // This promise would reject if the provider had declared itself ready before we resolve `resolveWhenFinished`
-        await Promise.race([resolveWhenFinished.promise, errorIfReadyFirst]);
-    });
-
-    it('should report values in file when `ready` resolves.', async () => {
-        fileService.releaseContent.resolve();
-        await provider.ready;
-        expect(provider.get('editor.fontSize')).to.equal(20); // The value provided by the mock FileService implementation.
-    });
-});
+// *****************************************************************************
+// Copyright (C) 2021 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 { enableJSDOM } from '@theia/core/lib/browser/test/jsdom';
+const disableJSDOM = enableJSDOM();
+
+import { FrontendApplicationConfigProvider } from '@theia/core/lib/browser/frontend-application-config-provider';
+FrontendApplicationConfigProvider.set({});
+
+import { expect } from 'chai';
+import { Container } from '@theia/core/shared/inversify';
+import { AbstractResourcePreferenceProvider } from './abstract-resource-preference-provider';
+import { FileService } from '@theia/filesystem/lib/browser/file-service';
+import { bindPreferenceService } from '@theia/core/lib/browser/frontend-application-bindings';
+import { bindMockPreferenceProviders } from '@theia/core/lib/browser/preferences/test';
+import { Deferred } from '@theia/core/lib/common/promise-util';
+import { Disposable, MessageService } from '@theia/core/lib/common';
+import { MonacoWorkspace } from '@theia/monaco/lib/browser/monaco-workspace';
+import { PreferenceSchemaProvider } from '@theia/core/lib/browser';
+import { EditorManager } from '@theia/editor/lib/browser';
+import { PreferenceTransactionFactory } from './preference-transaction-manager';
+
+disableJSDOM();
+
+class MockFileService {
+    releaseContent = new Deferred();
+    async read(): Promise<{ value: string }> {
+        await this.releaseContent.promise;
+        return { value: JSON.stringify({ 'editor.fontSize': 20 }) };
+    }
+    watch = RETURN_DISPOSABLE;
+    onDidFilesChange = RETURN_DISPOSABLE;
+}
+
+const RETURN_DISPOSABLE = () => Disposable.NULL;
+
+const mockSchemaProvider = { getCombinedSchema: () => ({ properties: {} }) };
+
+class LessAbstractPreferenceProvider extends AbstractResourcePreferenceProvider {
+    getUri(): any { }
+    getScope(): any { }
+}
+
+describe('AbstractResourcePreferenceProvider', () => {
+    let provider: AbstractResourcePreferenceProvider;
+    let fileService: MockFileService;
+
+    beforeEach(() => {
+        fileService = new MockFileService();
+        const testContainer = new Container();
+        bindPreferenceService(testContainer.bind.bind(testContainer));
+        bindMockPreferenceProviders(testContainer.bind.bind(testContainer), testContainer.unbind.bind(testContainer));
+        testContainer.rebind(<any>PreferenceSchemaProvider).toConstantValue(mockSchemaProvider);
+        testContainer.bind(<any>FileService).toConstantValue(fileService);
+        testContainer.bind(<any>MessageService).toConstantValue(undefined);
+        testContainer.bind(<any>MonacoWorkspace).toConstantValue(undefined);
+        testContainer.bind(<any>EditorManager).toConstantValue(undefined);
+        testContainer.bind(<any>PreferenceTransactionFactory).toConstantValue(undefined);
+        provider = testContainer.resolve(<any>LessAbstractPreferenceProvider);
+    });
+
+    it('should not store any preferences before it is ready.', async () => {
+        const resolveWhenFinished = new Deferred();
+        const errorIfReadyFirst = provider.ready.then(() => Promise.reject());
+
+        expect(provider.get('editor.fontSize')).to.be.undefined;
+
+        resolveWhenFinished.resolve();
+        fileService.releaseContent.resolve(); // Allow the initialization to run
+
+        // This promise would reject if the provider had declared itself ready before we resolve `resolveWhenFinished`
+        await Promise.race([resolveWhenFinished.promise, errorIfReadyFirst]);
+    });
+
+    it('should report values in file when `ready` resolves.', async () => {
+        fileService.releaseContent.resolve();
+        await provider.ready;
+        expect(provider.get('editor.fontSize')).to.equal(20); // The value provided by the mock FileService implementation.
+    });
+});