@theia/preferences 1.59.0 → 1.60.0-next.47

package/src/browser/views/components/preference-json-input.ts

@@ -18,7 +18,7 @@ import { PreferenceLeafNodeRenderer, PreferenceNodeRenderer } from './preference
 import { injectable, inject, interfaces } from '@theia/core/shared/inversify';
 import { CommandService, nls } from '@theia/core/lib/common';
 import { Preference, PreferencesCommands } from '../../util/preference-types';
-import { JSONValue } from '@theia/core/shared/@phosphor/coreutils';
+import { JSONValue } from '@theia/core/shared/@lumino/coreutils';
 import { PreferenceLeafNodeRendererContribution } from './preference-node-renderer-creator';
 
 @injectable()

package/src/browser/views/components/preference-node-renderer.ts

@@ -23,7 +23,7 @@ import { Preference, PreferenceMenus } from '../../util/preference-types';
 import { PreferenceTreeLabelProvider } from '../../util/preference-tree-label-provider';
 import { PreferencesScopeTabBar } from '../preference-scope-tabbar-widget';
 import { Disposable, nls } from '@theia/core/lib/common';
-import { JSONValue } from '@theia/core/shared/@phosphor/coreutils';
+import { JSONValue } from '@theia/core/shared/@lumino/coreutils';
 import debounce = require('@theia/core/shared/lodash.debounce');
 import { PreferenceTreeModel } from '../../preference-tree-model';
 import { PreferencesSearchbarWidget } from '../preference-searchbar-widget';

package/src/browser/views/components/preference-null-input.ts

@@ -0,0 +1,52 @@
+// *****************************************************************************
+// Copyright (C) 2025 EclipseSource GmbH 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, interfaces } from '@theia/core/shared/inversify';
+import { PreferenceLeafNodeRenderer, PreferenceNodeRenderer } from './preference-node-renderer';
+import { Preference } from '../../util/preference-types';
+import { PreferenceLeafNodeRendererContribution } from './preference-node-renderer-creator';
+
+@injectable()
+/** For rendering preference items for which the only interesting feature is the description */
+export class PreferenceNullInputRenderer extends PreferenceLeafNodeRenderer<null, HTMLElement> {
+    protected override createInteractable(container: HTMLElement): void {
+        const span = document.createElement('span');
+        this.interactable = span;
+        container.appendChild(span);
+    }
+
+    protected override getFallbackValue(): null {
+        // eslint-disable-next-line no-null/no-null
+        return null;
+    }
+
+    protected override doHandleValueChange(): void { }
+}
+
+@injectable()
+export class PreferenceNullRendererContribution extends PreferenceLeafNodeRendererContribution {
+    static ID = 'preference-null-renderer';
+    id = PreferenceNullRendererContribution.ID;
+
+    canHandleLeafNode(node: Preference.LeafNode): number {
+        const isOnlyNull = node.preference.data.type === 'null' || Array.isArray(node.preference.data.type) && node.preference.data.type.every(candidate => candidate === 'null');
+        return isOnlyNull ? 5 : 0;
+    }
+
+    createLeafNodeRenderer(container: interfaces.Container): PreferenceNodeRenderer {
+        return container.get(PreferenceNullInputRenderer);
+    }
+}

package/src/browser/views/components/preference-number-input.ts

@@ -14,7 +14,7 @@
 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
 // *****************************************************************************
 
-import { nls } from '@theia/core';
+import { nls, isBoolean, isNumber } from '@theia/core';
 import { injectable, interfaces } from '@theia/core/shared/inversify';
 import { Preference } from '../../util/preference-types';
 import { PreferenceLeafNodeRenderer, PreferenceNodeRenderer } from './preference-node-renderer';
@@ -105,15 +105,51 @@ export class PreferenceNumberInputRenderer extends PreferenceLeafNodeRenderer<nu
         if (input === '' || isNaN(inputValue)) {
             return { value: NaN, message: nls.localizeByDefault('Value must be a number.') };
         }
-        if (data.minimum && inputValue < data.minimum) {
-            errorMessages.push(nls.localizeByDefault('Value must be greater than or equal to {0}.', data.minimum));
-        };
-        if (data.maximum && inputValue > data.maximum) {
-            errorMessages.push(nls.localizeByDefault('Value must be less than or equal to {0}.', data.maximum));
-        };
         if (data.type === 'integer' && !Number.isInteger(inputValue)) {
             errorMessages.push(nls.localizeByDefault('Value must be an integer.'));
         }
+        if (data.minimum !== undefined && isFinite(data.minimum)) {
+            // https://json-schema.org/understanding-json-schema/reference/numeric
+            // "In JSON Schema Draft 4, exclusiveMinimum and exclusiveMaximum work differently.
+            // There they are boolean values, that indicate whether minimum and maximum are exclusive of the value"
+            if (isBoolean(data.exclusiveMinimum) && data.exclusiveMinimum) {
+                if (inputValue <= data.minimum) {
+                    errorMessages.push(nls.localizeByDefault('Value must be strictly greater than {0}.', data.minimum));
+                }
+            } else {
+                if (inputValue < data.minimum) {
+                    errorMessages.push(nls.localizeByDefault('Value must be greater than or equal to {0}.', data.minimum));
+                }
+            }
+        }
+        if (data.maximum !== undefined && isFinite(data.maximum)) {
+            // https://json-schema.org/understanding-json-schema/reference/numeric
+            // "In JSON Schema Draft 4, exclusiveMinimum and exclusiveMaximum work differently.
+            // There they are boolean values, that indicate whether minimum and maximum are exclusive of the value"
+            if (isBoolean(data.exclusiveMaximum) && data.exclusiveMaximum) {
+                if (inputValue >= data.maximum) {
+                    errorMessages.push(nls.localizeByDefault('Value must be strictly less than {0}.', data.maximum));
+                }
+            } else {
+                if (inputValue > data.maximum) {
+                    errorMessages.push(nls.localizeByDefault('Value must be less than or equal to {0}.', data.maximum));
+                }
+            }
+        }
+        // Using JSON Schema before Draft 4 both exclusive and non-exclusive variants can be set
+        if (isNumber(data.exclusiveMinimum) && isFinite(data.exclusiveMinimum)) {
+            if (inputValue <= data.exclusiveMinimum) {
+                errorMessages.push(nls.localizeByDefault('Value must be strictly greater than {0}.', data.exclusiveMinimum));
+            }
+        }
+        if (isNumber(data.exclusiveMaximum) && isFinite(data.exclusiveMaximum)) {
+            if (inputValue >= data.exclusiveMaximum) {
+                errorMessages.push(nls.localizeByDefault('Value must be strictly less than {0}.', data.exclusiveMaximum));
+            }
+        }
+        if (isNumber(data.multipleOf) && data.multipleOf !== 0 && !Number.isInteger(inputValue / data.multipleOf)) {
+            errorMessages.push(nls.localizeByDefault('Value must be a multiple of {0}.', data.multipleOf));
+        }
 
         return {
             value: errorMessages.length ? NaN : inputValue,

package/src/browser/views/components/preference-select-input.ts

@@ -16,7 +16,7 @@
 
 import { PreferenceLeafNodeRenderer, PreferenceNodeRenderer } from './preference-node-renderer';
 import { injectable, interfaces } from '@theia/core/shared/inversify';
-import { JSONValue } from '@theia/core/shared/@phosphor/coreutils';
+import { JSONValue } from '@theia/core/shared/@lumino/coreutils';
 import { PreferenceProvider } from '@theia/core/lib/browser/preferences/preference-provider';
 import { SelectComponent, SelectOption } from '@theia/core/lib/browser/widgets/select-component';
 import { Preference } from '../../util/preference-types';

package/src/browser/views/preference-editor-widget.ts

@@ -275,9 +275,12 @@ export class PreferencesEditorWidget extends BaseWidget implements StatefulWidge
         }
     }
 
+    protected shouldUpdateModelSelection = true;
+
     protected setFirstVisibleChildID(id?: string): void {
         if (id && id !== this.firstVisibleChildID) {
             this.firstVisibleChildID = id;
+            if (!this.shouldUpdateModelSelection) { return; }
             let currentNode = this.model.getNode(id);
             let expansionAncestor;
             let selectionAncestor;
@@ -314,18 +317,26 @@ export class PreferencesEditorWidget extends BaseWidget implements StatefulWidge
                     if (renderer?.visible) {
                         // When filtered, treat the first visible child as the selected node, since it will be the one scrolled to.
                         this.lastUserSelection = renderer.nodeId;
-                        renderer.node.scrollIntoView();
+                        this.scrollWithoutModelUpdate(renderer.node);
                         return;
                     }
                 }
             } else {
                 const { id, collection } = this.analyzeIDAndGetRendererGroup(node.id);
                 const renderer = collection.get(id);
-                renderer?.node.scrollIntoView();
+                this.scrollWithoutModelUpdate(renderer?.node);
             }
         }
     }
 
+    /** Ensures that we don't set the model's selection while attempting to scroll in reaction to a model selection change. */
+    protected scrollWithoutModelUpdate(node?: HTMLElement): void {
+        if (!node) { return; }
+        this.shouldUpdateModelSelection = false;
+        node.scrollIntoView();
+        requestAnimationFrame(() => this.shouldUpdateModelSelection = true);
+    }
+
     protected analyzeIDAndGetRendererGroup(nodeID: string): { id: string, group: string, collection: Map<string, GeneralPreferenceNodeRenderer> } {
         const { id, group } = Preference.TreeNode.getGroupAndIdFromNodeId(nodeID);
         const collection = group === COMMONLY_USED_SECTION_PREFIX ? this.commonlyUsedRenderers : this.renderers;

package/src/browser/views/preference-scope-tabbar-widget.tsx

@@ -15,7 +15,7 @@
 // *****************************************************************************
 
 import { inject, injectable, postConstruct } from '@theia/core/shared/inversify';
-import { TabBar, Widget, Title } from '@theia/core/shared/@phosphor/widgets';
+import { TabBar, Widget, Title } from '@theia/core/shared/@lumino/widgets';
 import { PreferenceScope, Message, ContextMenuRenderer, LabelProvider, StatefulWidget, codicon } from '@theia/core/lib/browser';
 import { WorkspaceService } from '@theia/workspace/lib/browser/workspace-service';
 import URI from '@theia/core/lib/common/uri';

package/src/browser/views/preference-widget-bindings.ts

@@ -36,6 +36,7 @@ import { PreferencesScopeTabBar } from './preference-scope-tabbar-widget';
 import { PreferencesSearchbarWidget } from './preference-searchbar-widget';
 import { PreferencesTreeWidget } from './preference-tree-widget';
 import { PreferencesWidget } from './preference-widget';
+import { PreferenceNullInputRenderer, PreferenceNullRendererContribution } from './components/preference-null-input';
 
 export function bindPreferencesWidgets(bind: interfaces.Bind): void {
     bind(PreferenceTreeLabelProvider).toSelf().inSingletonScope();
@@ -58,6 +59,8 @@ export function bindPreferencesWidgets(bind: interfaces.Bind): void {
 
     bind(PreferenceStringInputRenderer).toSelf();
     bind(PreferenceNodeRendererContribution).to(PreferenceStringInputRendererContribution).inSingletonScope();
+    bind(PreferenceNullInputRenderer).toSelf();
+    bind(PreferenceNodeRendererContribution).to(PreferenceNullRendererContribution).inSingletonScope();
 
     bind(PreferenceBooleanInputRenderer).toSelf();
     bind(PreferenceNodeRendererContribution).to(PreferenceBooleanInputRendererContribution).inSingletonScope();