@theia/preferences 1.45.1 → 1.46.0-next.72

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

@@ -1,104 +1,104 @@
-// *****************************************************************************
-// Copyright (C) 2022 EclipseSource 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 { isObject } from '@theia/core/lib/common';
-import { nls } from '@theia/core/lib/common/nls';
-import { inject, injectable, interfaces } from '@theia/core/shared/inversify';
-import { OpenFileDialogProps } from '@theia/filesystem/lib/browser';
-import { FileDialogService } from '@theia/filesystem/lib/browser/file-dialog/file-dialog-service';
-import { WorkspaceCommands } from '@theia/workspace/lib/browser';
-import { Preference } from '../../util/preference-types';
-import { PreferenceNodeRenderer } from './preference-node-renderer';
-import { PreferenceLeafNodeRendererContribution } from './preference-node-renderer-creator';
-import { PreferenceStringInputRenderer } from './preference-string-input';
-
-export interface FileNodeTypeDetails {
-    isFilepath: true;
-    selectionProps?: Partial<OpenFileDialogProps>;
-}
-
-export namespace FileNodeTypeDetails {
-    export function is(typeDetails: unknown): typeDetails is FileNodeTypeDetails {
-        return isObject<FileNodeTypeDetails>(typeDetails) && !!typeDetails.isFilepath;
-    }
-}
-
-@injectable()
-export class PreferenceSingleFilePathInputRendererContribution extends PreferenceLeafNodeRendererContribution {
-    static ID = 'preference-single-file-path-input-renderer';
-    id = PreferenceSingleFilePathInputRendererContribution.ID;
-
-    canHandleLeafNode(node: Preference.LeafNode): number {
-        const typeDetails = node.preference.data.typeDetails;
-        return FileNodeTypeDetails.is(typeDetails) && !typeDetails.selectionProps?.canSelectMany ? 5 : 0;
-    }
-
-    createLeafNodeRenderer(container: interfaces.Container): PreferenceNodeRenderer {
-        return container.get(PreferenceSingleFilePathInputRenderer);
-    }
-}
-
-@injectable()
-export class PreferenceSingleFilePathInputRenderer extends PreferenceStringInputRenderer {
-    @inject(FileDialogService) fileDialogService: FileDialogService;
-
-    get typeDetails(): FileNodeTypeDetails {
-        return this.preferenceNode.preference.data.typeDetails as FileNodeTypeDetails;
-    }
-
-    protected createInputWrapper(): HTMLElement {
-        const inputWrapper = document.createElement('div');
-        inputWrapper.classList.add('preference-file-container');
-        return inputWrapper;
-    }
-
-    protected override createInteractable(parent: HTMLElement): void {
-        const inputWrapper = this.createInputWrapper();
-
-        super.createInteractable(inputWrapper);
-        this.interactable.classList.add('preference-file-input');
-
-        this.createBrowseButton(inputWrapper);
-
-        parent.appendChild(inputWrapper);
-    }
-
-    protected createBrowseButton(parent: HTMLElement): void {
-        const button = document.createElement('button');
-        button.classList.add('theia-button', 'main', 'preference-file-button');
-        button.textContent = nls.localize('theia/core/file/browse', 'Browse');
-        const handler = this.browse.bind(this);
-        button.onclick = handler;
-        button.onkeydown = handler;
-        button.tabIndex = 0;
-        button.setAttribute('aria-label', 'Submit Preference Input');
-        parent.appendChild(button);
-    }
-
-    protected async browse(): Promise<void> {
-        const selectionProps = this.typeDetails.selectionProps;
-        const title = selectionProps?.title ?? selectionProps?.canSelectFolders ? WorkspaceCommands.OPEN_FOLDER.dialogLabel : WorkspaceCommands.OPEN_FILE.dialogLabel;
-        const selection = await this.fileDialogService.showOpenDialog({ title, ...selectionProps });
-        if (selection) {
-            this.setPreferenceImmediately(selection.path.fsPath());
-        }
-    }
-
-    protected override setPreferenceImmediately(value: string): Promise<void> {
-        this.interactable.value = value;
-        return super.setPreferenceImmediately(value);
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2022 EclipseSource 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 { isObject } from '@theia/core/lib/common';
+import { nls } from '@theia/core/lib/common/nls';
+import { inject, injectable, interfaces } from '@theia/core/shared/inversify';
+import { OpenFileDialogProps } from '@theia/filesystem/lib/browser';
+import { FileDialogService } from '@theia/filesystem/lib/browser/file-dialog/file-dialog-service';
+import { WorkspaceCommands } from '@theia/workspace/lib/browser';
+import { Preference } from '../../util/preference-types';
+import { PreferenceNodeRenderer } from './preference-node-renderer';
+import { PreferenceLeafNodeRendererContribution } from './preference-node-renderer-creator';
+import { PreferenceStringInputRenderer } from './preference-string-input';
+
+export interface FileNodeTypeDetails {
+    isFilepath: true;
+    selectionProps?: Partial<OpenFileDialogProps>;
+}
+
+export namespace FileNodeTypeDetails {
+    export function is(typeDetails: unknown): typeDetails is FileNodeTypeDetails {
+        return isObject<FileNodeTypeDetails>(typeDetails) && !!typeDetails.isFilepath;
+    }
+}
+
+@injectable()
+export class PreferenceSingleFilePathInputRendererContribution extends PreferenceLeafNodeRendererContribution {
+    static ID = 'preference-single-file-path-input-renderer';
+    id = PreferenceSingleFilePathInputRendererContribution.ID;
+
+    canHandleLeafNode(node: Preference.LeafNode): number {
+        const typeDetails = node.preference.data.typeDetails;
+        return FileNodeTypeDetails.is(typeDetails) && !typeDetails.selectionProps?.canSelectMany ? 5 : 0;
+    }
+
+    createLeafNodeRenderer(container: interfaces.Container): PreferenceNodeRenderer {
+        return container.get(PreferenceSingleFilePathInputRenderer);
+    }
+}
+
+@injectable()
+export class PreferenceSingleFilePathInputRenderer extends PreferenceStringInputRenderer {
+    @inject(FileDialogService) fileDialogService: FileDialogService;
+
+    get typeDetails(): FileNodeTypeDetails {
+        return this.preferenceNode.preference.data.typeDetails as FileNodeTypeDetails;
+    }
+
+    protected createInputWrapper(): HTMLElement {
+        const inputWrapper = document.createElement('div');
+        inputWrapper.classList.add('preference-file-container');
+        return inputWrapper;
+    }
+
+    protected override createInteractable(parent: HTMLElement): void {
+        const inputWrapper = this.createInputWrapper();
+
+        super.createInteractable(inputWrapper);
+        this.interactable.classList.add('preference-file-input');
+
+        this.createBrowseButton(inputWrapper);
+
+        parent.appendChild(inputWrapper);
+    }
+
+    protected createBrowseButton(parent: HTMLElement): void {
+        const button = document.createElement('button');
+        button.classList.add('theia-button', 'main', 'preference-file-button');
+        button.textContent = nls.localize('theia/core/file/browse', 'Browse');
+        const handler = this.browse.bind(this);
+        button.onclick = handler;
+        button.onkeydown = handler;
+        button.tabIndex = 0;
+        button.setAttribute('aria-label', 'Submit Preference Input');
+        parent.appendChild(button);
+    }
+
+    protected async browse(): Promise<void> {
+        const selectionProps = this.typeDetails.selectionProps;
+        const title = selectionProps?.title ?? selectionProps?.canSelectFolders ? WorkspaceCommands.OPEN_FOLDER.dialogLabel : WorkspaceCommands.OPEN_FILE.dialogLabel;
+        const selection = await this.fileDialogService.showOpenDialog({ title, ...selectionProps });
+        if (selection) {
+            this.setPreferenceImmediately(selection.path.fsPath());
+        }
+    }
+
+    protected override setPreferenceImmediately(value: string): Promise<void> {
+        this.interactable.value = value;
+        return super.setPreferenceImmediately(value);
+    }
+}

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

@@ -1,78 +1,78 @@
-// *****************************************************************************
-// 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
-// *****************************************************************************
-
-import { PreferenceLeafNodeRenderer, PreferenceNodeRenderer } from './preference-node-renderer';
-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 { PreferenceLeafNodeRendererContribution } from './preference-node-renderer-creator';
-
-@injectable()
-export class PreferenceJSONLinkRenderer extends PreferenceLeafNodeRenderer<JSONValue, HTMLAnchorElement> {
-    @inject(CommandService) protected readonly commandService: CommandService;
-
-    protected createInteractable(parent: HTMLElement): void {
-        const message = nls.localizeByDefault('Edit in settings.json');
-        const interactable = document.createElement('a');
-        this.interactable = interactable;
-        interactable.classList.add('theia-json-input');
-        interactable.setAttribute('role', 'button');
-        interactable.title = message;
-        interactable.textContent = message;
-        interactable.onclick = this.handleUserInteraction.bind(this);
-        interactable.onkeydown = this.handleUserInteraction.bind(this);
-        parent.appendChild(interactable);
-    }
-
-    protected getFallbackValue(): JSONValue {
-        const node = this.preferenceNode;
-        const type = Array.isArray(node.preference.data.type) ? node.preference.data.type[0] : node.preference.data.type;
-        switch (type) {
-            case 'object':
-                return {};
-            case 'array':
-                return [];
-            case 'null':
-                return null; // eslint-disable-line no-null/no-null
-            default: // Should all be handled by other input types.
-                return '';
-        }
-    }
-
-    protected doHandleValueChange(): void {
-        this.updateInspection();
-        this.updateModificationStatus();
-    }
-
-    protected handleUserInteraction(): void {
-        this.commandService.executeCommand(PreferencesCommands.OPEN_PREFERENCES_JSON_TOOLBAR.id, this.id);
-    }
-}
-
-@injectable()
-export class PreferenceJSONLinkRendererContribution extends PreferenceLeafNodeRendererContribution {
-    static ID = 'preference-json-link-renderer';
-    id = PreferenceJSONLinkRendererContribution.ID;
-
-    canHandleLeafNode(_node: Preference.LeafNode): number {
-        return 1;
-    }
-
-    createLeafNodeRenderer(container: interfaces.Container): PreferenceNodeRenderer {
-        return container.get(PreferenceJSONLinkRenderer);
-    }
-}
+// *****************************************************************************
+// 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
+// *****************************************************************************
+
+import { PreferenceLeafNodeRenderer, PreferenceNodeRenderer } from './preference-node-renderer';
+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 { PreferenceLeafNodeRendererContribution } from './preference-node-renderer-creator';
+
+@injectable()
+export class PreferenceJSONLinkRenderer extends PreferenceLeafNodeRenderer<JSONValue, HTMLAnchorElement> {
+    @inject(CommandService) protected readonly commandService: CommandService;
+
+    protected createInteractable(parent: HTMLElement): void {
+        const message = nls.localizeByDefault('Edit in settings.json');
+        const interactable = document.createElement('a');
+        this.interactable = interactable;
+        interactable.classList.add('theia-json-input');
+        interactable.setAttribute('role', 'button');
+        interactable.title = message;
+        interactable.textContent = message;
+        interactable.onclick = this.handleUserInteraction.bind(this);
+        interactable.onkeydown = this.handleUserInteraction.bind(this);
+        parent.appendChild(interactable);
+    }
+
+    protected getFallbackValue(): JSONValue {
+        const node = this.preferenceNode;
+        const type = Array.isArray(node.preference.data.type) ? node.preference.data.type[0] : node.preference.data.type;
+        switch (type) {
+            case 'object':
+                return {};
+            case 'array':
+                return [];
+            case 'null':
+                return null; // eslint-disable-line no-null/no-null
+            default: // Should all be handled by other input types.
+                return '';
+        }
+    }
+
+    protected doHandleValueChange(): void {
+        this.updateInspection();
+        this.updateModificationStatus();
+    }
+
+    protected handleUserInteraction(): void {
+        this.commandService.executeCommand(PreferencesCommands.OPEN_PREFERENCES_JSON_TOOLBAR.id, this.id);
+    }
+}
+
+@injectable()
+export class PreferenceJSONLinkRendererContribution extends PreferenceLeafNodeRendererContribution {
+    static ID = 'preference-json-link-renderer';
+    id = PreferenceJSONLinkRendererContribution.ID;
+
+    canHandleLeafNode(_node: Preference.LeafNode): number {
+        return 1;
+    }
+
+    createLeafNodeRenderer(container: interfaces.Container): PreferenceNodeRenderer {
+        return container.get(PreferenceJSONLinkRenderer);
+    }
+}

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

@@ -1,68 +1,68 @@
-// *****************************************************************************
-// Copyright (C) 2023 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 { PreferenceTreeModel } from '../../preference-tree-model';
-import { PreferenceTreeLabelProvider } from '../../util/preference-tree-label-provider';
-import * as markdownit from '@theia/core/shared/markdown-it';
-
-@injectable()
-export class PreferenceMarkdownRenderer {
-
-    @inject(PreferenceTreeModel) protected readonly model: PreferenceTreeModel;
-    @inject(PreferenceTreeLabelProvider) protected readonly labelProvider: PreferenceTreeLabelProvider;
-
-    protected _renderer?: markdownit;
-
-    render(text: string): string {
-        return this.getRenderer().render(text);
-    }
-
-    renderInline(text: string): string {
-        return this.getRenderer().renderInline(text);
-    }
-
-    protected getRenderer(): markdownit {
-        this._renderer ??= this.buildMarkdownRenderer();
-        return this._renderer;
-    }
-
-    protected buildMarkdownRenderer(): markdownit {
-        const engine = markdownit();
-        const inlineCode = engine.renderer.rules.code_inline;
-
-        engine.renderer.rules.code_inline = (tokens, idx, options, env, self) => {
-            const token = tokens[idx];
-            const content = token.content;
-            if (content.startsWith('#') && content.endsWith('#')) {
-                const preferenceId = content.substring(1, content.length - 1);
-                const preferenceNode = this.model.getNodeFromPreferenceId(preferenceId);
-                if (preferenceNode) {
-                    let name = this.labelProvider.getName(preferenceNode);
-                    const prefix = this.labelProvider.getPrefix(preferenceNode, true);
-                    if (prefix) {
-                        name = prefix + name;
-                    }
-                    return `<a title="${preferenceId}" href="preference:${preferenceId}">${name}</a>`;
-                } else {
-                    console.warn(`Linked preference "${preferenceId}" not found.`);
-                }
-            }
-            return inlineCode ? inlineCode(tokens, idx, options, env, self) : '';
-        };
-        return engine;
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2023 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 { PreferenceTreeModel } from '../../preference-tree-model';
+import { PreferenceTreeLabelProvider } from '../../util/preference-tree-label-provider';
+import * as markdownit from '@theia/core/shared/markdown-it';
+
+@injectable()
+export class PreferenceMarkdownRenderer {
+
+    @inject(PreferenceTreeModel) protected readonly model: PreferenceTreeModel;
+    @inject(PreferenceTreeLabelProvider) protected readonly labelProvider: PreferenceTreeLabelProvider;
+
+    protected _renderer?: markdownit;
+
+    render(text: string): string {
+        return this.getRenderer().render(text);
+    }
+
+    renderInline(text: string): string {
+        return this.getRenderer().renderInline(text);
+    }
+
+    protected getRenderer(): markdownit {
+        this._renderer ??= this.buildMarkdownRenderer();
+        return this._renderer;
+    }
+
+    protected buildMarkdownRenderer(): markdownit {
+        const engine = markdownit();
+        const inlineCode = engine.renderer.rules.code_inline;
+
+        engine.renderer.rules.code_inline = (tokens, idx, options, env, self) => {
+            const token = tokens[idx];
+            const content = token.content;
+            if (content.startsWith('#') && content.endsWith('#')) {
+                const preferenceId = content.substring(1, content.length - 1);
+                const preferenceNode = this.model.getNodeFromPreferenceId(preferenceId);
+                if (preferenceNode) {
+                    let name = this.labelProvider.getName(preferenceNode);
+                    const prefix = this.labelProvider.getPrefix(preferenceNode, true);
+                    if (prefix) {
+                        name = prefix + name;
+                    }
+                    return `<a title="${preferenceId}" href="preference:${preferenceId}">${name}</a>`;
+                } else {
+                    console.warn(`Linked preference "${preferenceId}" not found.`);
+                }
+            }
+            return inlineCode ? inlineCode(tokens, idx, options, env, self) : '';
+        };
+        return engine;
+    }
+}