@theia/markers 1.45.1 → 1.46.0-next.72

package/src/browser/problem/problem-preferences.ts

@@ -1,64 +1,64 @@
-// *****************************************************************************
-// 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 { interfaces } from '@theia/core/shared/inversify';
-import { createPreferenceProxy, PreferenceProxy, PreferenceService, PreferenceContribution, PreferenceSchema } from '@theia/core/lib/browser';
-import { nls } from '@theia/core/lib/common/nls';
-
-export const ProblemConfigSchema: PreferenceSchema = {
-    'type': 'object',
-    'properties': {
-        'problems.decorations.enabled': {
-            'type': 'boolean',
-            'description': nls.localizeByDefault('Show Errors & Warnings on files and folder.'),
-            'default': true,
-        },
-        'problems.decorations.tabbar.enabled': {
-            'type': 'boolean',
-            'description': nls.localize('theia/markers/tabbarDecorationsEnabled', 'Show problem decorators (diagnostic markers) in the tab bars.'),
-            'default': true
-        },
-        'problems.autoReveal': {
-            'type': 'boolean',
-            'description': nls.localizeByDefault('Controls whether Problems view should automatically reveal files when opening them.'),
-            'default': true
-        }
-    }
-};
-
-export interface ProblemConfiguration {
-    'problems.decorations.enabled': boolean,
-    'problems.decorations.tabbar.enabled': boolean,
-    'problems.autoReveal': boolean
-}
-
-export const ProblemPreferenceContribution = Symbol('ProblemPreferenceContribution');
-export const ProblemPreferences = Symbol('ProblemPreferences');
-export type ProblemPreferences = PreferenceProxy<ProblemConfiguration>;
-
-export function createProblemPreferences(preferences: PreferenceService, schema: PreferenceSchema = ProblemConfigSchema): ProblemPreferences {
-    return createPreferenceProxy(preferences, schema);
-}
-
-export const bindProblemPreferences = (bind: interfaces.Bind): void => {
-    bind(ProblemPreferences).toDynamicValue(ctx => {
-        const preferences = ctx.container.get<PreferenceService>(PreferenceService);
-        const contribution = ctx.container.get<PreferenceContribution>(ProblemPreferenceContribution);
-        return createProblemPreferences(preferences, contribution.schema);
-    }).inSingletonScope();
-    bind(ProblemPreferenceContribution).toConstantValue({ schema: ProblemConfigSchema });
-    bind(PreferenceContribution).toService(ProblemPreferenceContribution);
-};
+// *****************************************************************************
+// 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 { interfaces } from '@theia/core/shared/inversify';
+import { createPreferenceProxy, PreferenceProxy, PreferenceService, PreferenceContribution, PreferenceSchema } from '@theia/core/lib/browser';
+import { nls } from '@theia/core/lib/common/nls';
+
+export const ProblemConfigSchema: PreferenceSchema = {
+    'type': 'object',
+    'properties': {
+        'problems.decorations.enabled': {
+            'type': 'boolean',
+            'description': nls.localizeByDefault('Show Errors & Warnings on files and folder.'),
+            'default': true,
+        },
+        'problems.decorations.tabbar.enabled': {
+            'type': 'boolean',
+            'description': nls.localize('theia/markers/tabbarDecorationsEnabled', 'Show problem decorators (diagnostic markers) in the tab bars.'),
+            'default': true
+        },
+        'problems.autoReveal': {
+            'type': 'boolean',
+            'description': nls.localizeByDefault('Controls whether Problems view should automatically reveal files when opening them.'),
+            'default': true
+        }
+    }
+};
+
+export interface ProblemConfiguration {
+    'problems.decorations.enabled': boolean,
+    'problems.decorations.tabbar.enabled': boolean,
+    'problems.autoReveal': boolean
+}
+
+export const ProblemPreferenceContribution = Symbol('ProblemPreferenceContribution');
+export const ProblemPreferences = Symbol('ProblemPreferences');
+export type ProblemPreferences = PreferenceProxy<ProblemConfiguration>;
+
+export function createProblemPreferences(preferences: PreferenceService, schema: PreferenceSchema = ProblemConfigSchema): ProblemPreferences {
+    return createPreferenceProxy(preferences, schema);
+}
+
+export const bindProblemPreferences = (bind: interfaces.Bind): void => {
+    bind(ProblemPreferences).toDynamicValue(ctx => {
+        const preferences = ctx.container.get<PreferenceService>(PreferenceService);
+        const contribution = ctx.container.get<PreferenceContribution>(ProblemPreferenceContribution);
+        return createProblemPreferences(preferences, contribution.schema);
+    }).inSingletonScope();
+    bind(ProblemPreferenceContribution).toConstantValue({ schema: ProblemConfigSchema });
+    bind(PreferenceContribution).toService(ProblemPreferenceContribution);
+};

package/src/browser/problem/problem-selection.ts

@@ -1,45 +1,45 @@
-// *****************************************************************************
-// 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 { SelectionService } from '@theia/core/lib/common/selection-service';
-import { SelectionCommandHandler } from '@theia/core/lib/common/selection-command-handler';
-import { isObject } from '@theia/core/lib/common';
-import { Marker } from '../../common/marker';
-import { ProblemMarker } from '../../common/problem-marker';
-
-export interface ProblemSelection {
-    marker: Marker<object>;
-}
-export namespace ProblemSelection {
-    export function is(arg: unknown): arg is ProblemSelection {
-        return isObject<ProblemSelection>(arg) && ProblemMarker.is(arg.marker);
-    }
-
-    export class CommandHandler extends SelectionCommandHandler<ProblemSelection> {
-
-        constructor(
-            selectionService: SelectionService,
-            options: SelectionCommandHandler.Options<ProblemSelection>
-        ) {
-            super(
-                selectionService,
-                arg => ProblemSelection.is(arg) ? arg : undefined,
-                options
-            );
-        }
-    }
-
-}
+// *****************************************************************************
+// 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 { SelectionService } from '@theia/core/lib/common/selection-service';
+import { SelectionCommandHandler } from '@theia/core/lib/common/selection-command-handler';
+import { isObject } from '@theia/core/lib/common';
+import { Marker } from '../../common/marker';
+import { ProblemMarker } from '../../common/problem-marker';
+
+export interface ProblemSelection {
+    marker: Marker<object>;
+}
+export namespace ProblemSelection {
+    export function is(arg: unknown): arg is ProblemSelection {
+        return isObject<ProblemSelection>(arg) && ProblemMarker.is(arg.marker);
+    }
+
+    export class CommandHandler extends SelectionCommandHandler<ProblemSelection> {
+
+        constructor(
+            selectionService: SelectionService,
+            options: SelectionCommandHandler.Options<ProblemSelection>
+        ) {
+            super(
+                selectionService,
+                arg => ProblemSelection.is(arg) ? arg : undefined,
+                options
+            );
+        }
+    }
+
+}

package/src/browser/problem/problem-tabbar-decorator.ts

@@ -1,151 +1,151 @@
-// *****************************************************************************
-// 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, postConstruct } from '@theia/core/shared/inversify';
-import { Diagnostic, DiagnosticSeverity } from '@theia/core/shared/vscode-languageserver-protocol';
-import { Event, Emitter } from '@theia/core/lib/common/event';
-import { Title, Widget } from '@theia/core/shared/@phosphor/widgets';
-import { WidgetDecoration } from '@theia/core/lib/browser/widget-decoration';
-import { TabBarDecorator } from '@theia/core/lib/browser/shell/tab-bar-decorator';
-import { Marker } from '../../common/marker';
-import { ProblemManager } from './problem-manager';
-import { ProblemPreferences, ProblemConfiguration } from './problem-preferences';
-import { PreferenceChangeEvent, Navigatable } from '@theia/core/lib/browser';
-
-@injectable()
-export class ProblemTabBarDecorator implements TabBarDecorator {
-
-    readonly id = 'theia-problem-tabbar-decorator';
-
-    protected readonly emitter = new Emitter<void>();
-
-    @inject(ProblemPreferences)
-    protected readonly preferences: ProblemPreferences;
-
-    @inject(ProblemManager)
-    protected readonly problemManager: ProblemManager;
-
-    @postConstruct()
-    protected init(): void {
-        this.problemManager.onDidChangeMarkers(() => this.fireDidChangeDecorations());
-        this.preferences.onPreferenceChanged(event => this.handlePreferenceChange(event));
-    }
-
-    decorate(title: Title<Widget>): WidgetDecoration.Data[] {
-        if (!this.preferences['problems.decorations.tabbar.enabled']) {
-            return [];
-        }
-        const widget = title.owner;
-        if (Navigatable.is(widget)) {
-            const resourceUri = widget.getResourceUri();
-            if (resourceUri) {
-                // Get the list of problem markers for the given resource URI.
-                const markers: Marker<Diagnostic>[] = this.problemManager.findMarkers({ uri: resourceUri });
-                // If no markers are available, return early.
-                if (markers.length === 0) {
-                    return [];
-                }
-                // Store the marker with the highest severity.
-                let maxSeverity: Marker<Diagnostic> | undefined;
-                // Iterate over available markers to determine that which has the highest severity.
-                // Only display a decoration if an error or warning marker is available.
-                for (const marker of markers) {
-                    // Break early if an error marker is present, since it represents the highest severity.
-                    if (marker.data.severity === DiagnosticSeverity.Error) {
-                        maxSeverity = marker;
-                        break;
-                    } else if (marker.data.severity === DiagnosticSeverity.Warning) {
-                        maxSeverity = marker;
-                    }
-                }
-                // Decorate the tabbar with the highest marker severity if available.
-                return maxSeverity ? [this.toDecorator(maxSeverity)] : [];
-            }
-        }
-        return [];
-    }
-
-    get onDidChangeDecorations(): Event<void> {
-        return this.emitter.event;
-    }
-
-    protected fireDidChangeDecorations(): void {
-        this.emitter.fire(undefined);
-    }
-
-    /**
-     * Handle changes in preference.
-     * @param {PreferenceChangeEvent<ProblemConfiguration>} event The event of the changes in preference.
-     */
-    protected async handlePreferenceChange(event: PreferenceChangeEvent<ProblemConfiguration>): Promise<void> {
-        const { preferenceName } = event;
-        if (preferenceName === 'problems.decorations.tabbar.enabled') {
-            this.fireDidChangeDecorations();
-        }
-    }
-
-    /**
-     * Convert a diagnostic marker to a decorator.
-     * @param {Marker<Diagnostic>} marker A diagnostic marker.
-     * @returns {WidgetDecoration.Data} The decoration data.
-     */
-    protected toDecorator(marker: Marker<Diagnostic>): WidgetDecoration.Data {
-        const position = WidgetDecoration.IconOverlayPosition.BOTTOM_RIGHT;
-        const icon = this.getOverlayIcon(marker);
-        const color = this.getOverlayIconColor(marker);
-        return {
-            iconOverlay: {
-                position,
-                icon,
-                color,
-                background: {
-                    shape: 'circle',
-                    color: 'transparent'
-                }
-            }
-        };
-    }
-
-    /**
-     * Get the appropriate overlay icon for decoration.
-     * @param {Marker<Diagnostic>} marker A diagnostic marker.
-     * @returns {string} A string representing the overlay icon class.
-     */
-    protected getOverlayIcon(marker: Marker<Diagnostic>): string {
-        const { severity } = marker.data;
-        switch (severity) {
-            case 1: return 'times-circle';
-            case 2: return 'exclamation-circle';
-            case 3: return 'info-circle';
-            default: return 'hand-o-up';
-        }
-    }
-
-    /**
-     * Get the appropriate overlay icon color for decoration.
-     * @param {Marker<Diagnostic>} marker A diagnostic marker.
-     * @returns {WidgetDecoration.Color} The decoration color.
-     */
-    protected getOverlayIconColor(marker: Marker<Diagnostic>): WidgetDecoration.Color {
-        const { severity } = marker.data;
-        switch (severity) {
-            case 1: return 'var(--theia-list-errorForeground)';
-            case 2: return 'var(--theia-list-warningForeground)';
-            default: return 'var(--theia-successBackground)';
-        }
-    }
-
-}
+// *****************************************************************************
+// 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, postConstruct } from '@theia/core/shared/inversify';
+import { Diagnostic, DiagnosticSeverity } from '@theia/core/shared/vscode-languageserver-protocol';
+import { Event, Emitter } from '@theia/core/lib/common/event';
+import { Title, Widget } from '@theia/core/shared/@phosphor/widgets';
+import { WidgetDecoration } from '@theia/core/lib/browser/widget-decoration';
+import { TabBarDecorator } from '@theia/core/lib/browser/shell/tab-bar-decorator';
+import { Marker } from '../../common/marker';
+import { ProblemManager } from './problem-manager';
+import { ProblemPreferences, ProblemConfiguration } from './problem-preferences';
+import { PreferenceChangeEvent, Navigatable } from '@theia/core/lib/browser';
+
+@injectable()
+export class ProblemTabBarDecorator implements TabBarDecorator {
+
+    readonly id = 'theia-problem-tabbar-decorator';
+
+    protected readonly emitter = new Emitter<void>();
+
+    @inject(ProblemPreferences)
+    protected readonly preferences: ProblemPreferences;
+
+    @inject(ProblemManager)
+    protected readonly problemManager: ProblemManager;
+
+    @postConstruct()
+    protected init(): void {
+        this.problemManager.onDidChangeMarkers(() => this.fireDidChangeDecorations());
+        this.preferences.onPreferenceChanged(event => this.handlePreferenceChange(event));
+    }
+
+    decorate(title: Title<Widget>): WidgetDecoration.Data[] {
+        if (!this.preferences['problems.decorations.tabbar.enabled']) {
+            return [];
+        }
+        const widget = title.owner;
+        if (Navigatable.is(widget)) {
+            const resourceUri = widget.getResourceUri();
+            if (resourceUri) {
+                // Get the list of problem markers for the given resource URI.
+                const markers: Marker<Diagnostic>[] = this.problemManager.findMarkers({ uri: resourceUri });
+                // If no markers are available, return early.
+                if (markers.length === 0) {
+                    return [];
+                }
+                // Store the marker with the highest severity.
+                let maxSeverity: Marker<Diagnostic> | undefined;
+                // Iterate over available markers to determine that which has the highest severity.
+                // Only display a decoration if an error or warning marker is available.
+                for (const marker of markers) {
+                    // Break early if an error marker is present, since it represents the highest severity.
+                    if (marker.data.severity === DiagnosticSeverity.Error) {
+                        maxSeverity = marker;
+                        break;
+                    } else if (marker.data.severity === DiagnosticSeverity.Warning) {
+                        maxSeverity = marker;
+                    }
+                }
+                // Decorate the tabbar with the highest marker severity if available.
+                return maxSeverity ? [this.toDecorator(maxSeverity)] : [];
+            }
+        }
+        return [];
+    }
+
+    get onDidChangeDecorations(): Event<void> {
+        return this.emitter.event;
+    }
+
+    protected fireDidChangeDecorations(): void {
+        this.emitter.fire(undefined);
+    }
+
+    /**
+     * Handle changes in preference.
+     * @param {PreferenceChangeEvent<ProblemConfiguration>} event The event of the changes in preference.
+     */
+    protected async handlePreferenceChange(event: PreferenceChangeEvent<ProblemConfiguration>): Promise<void> {
+        const { preferenceName } = event;
+        if (preferenceName === 'problems.decorations.tabbar.enabled') {
+            this.fireDidChangeDecorations();
+        }
+    }
+
+    /**
+     * Convert a diagnostic marker to a decorator.
+     * @param {Marker<Diagnostic>} marker A diagnostic marker.
+     * @returns {WidgetDecoration.Data} The decoration data.
+     */
+    protected toDecorator(marker: Marker<Diagnostic>): WidgetDecoration.Data {
+        const position = WidgetDecoration.IconOverlayPosition.BOTTOM_RIGHT;
+        const icon = this.getOverlayIcon(marker);
+        const color = this.getOverlayIconColor(marker);
+        return {
+            iconOverlay: {
+                position,
+                icon,
+                color,
+                background: {
+                    shape: 'circle',
+                    color: 'transparent'
+                }
+            }
+        };
+    }
+
+    /**
+     * Get the appropriate overlay icon for decoration.
+     * @param {Marker<Diagnostic>} marker A diagnostic marker.
+     * @returns {string} A string representing the overlay icon class.
+     */
+    protected getOverlayIcon(marker: Marker<Diagnostic>): string {
+        const { severity } = marker.data;
+        switch (severity) {
+            case 1: return 'times-circle';
+            case 2: return 'exclamation-circle';
+            case 3: return 'info-circle';
+            default: return 'hand-o-up';
+        }
+    }
+
+    /**
+     * Get the appropriate overlay icon color for decoration.
+     * @param {Marker<Diagnostic>} marker A diagnostic marker.
+     * @returns {WidgetDecoration.Color} The decoration color.
+     */
+    protected getOverlayIconColor(marker: Marker<Diagnostic>): WidgetDecoration.Color {
+        const { severity } = marker.data;
+        switch (severity) {
+            case 1: return 'var(--theia-list-errorForeground)';
+            case 2: return 'var(--theia-list-warningForeground)';
+            default: return 'var(--theia-successBackground)';
+        }
+    }
+
+}