@theia/getting-started 1.53.0-next.4 → 1.53.0-next.55

package/src/browser/getting-started-contribution.ts

@@ -1,126 +1,126 @@
-// *****************************************************************************
-// Copyright (C) 2018 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 { injectable, inject } from '@theia/core/shared/inversify';
-import { ArrayUtils, CommandRegistry, MenuModelRegistry } from '@theia/core/lib/common';
-import { CommonCommands, CommonMenus, AbstractViewContribution, FrontendApplicationContribution, FrontendApplication, PreferenceService } from '@theia/core/lib/browser';
-import { EditorManager } from '@theia/editor/lib/browser/editor-manager';
-import { GettingStartedWidget } from './getting-started-widget';
-import { FileService } from '@theia/filesystem/lib/browser/file-service';
-import { FrontendApplicationStateService } from '@theia/core/lib/browser/frontend-application-state';
-import { PreviewContribution } from '@theia/preview/lib/browser/preview-contribution';
-import { WorkspaceService } from '@theia/workspace/lib/browser';
-
-/**
- * Triggers opening the `GettingStartedWidget`.
- */
-export const GettingStartedCommand = {
-    id: GettingStartedWidget.ID,
-    label: GettingStartedWidget.LABEL
-};
-
-@injectable()
-export class GettingStartedContribution extends AbstractViewContribution<GettingStartedWidget> implements FrontendApplicationContribution {
-
-    @inject(CommandRegistry)
-    protected readonly commandRegistry: CommandRegistry;
-
-    @inject(EditorManager)
-    protected readonly editorManager: EditorManager;
-
-    @inject(FileService)
-    protected readonly fileService: FileService;
-
-    @inject(PreferenceService)
-    protected readonly preferenceService: PreferenceService;
-
-    @inject(PreviewContribution)
-    protected readonly previewContribution: PreviewContribution;
-
-    @inject(FrontendApplicationStateService)
-    protected readonly stateService: FrontendApplicationStateService;
-
-    @inject(WorkspaceService)
-    protected readonly workspaceService: WorkspaceService;
-
-    constructor() {
-        super({
-            widgetId: GettingStartedWidget.ID,
-            widgetName: GettingStartedWidget.LABEL,
-            defaultWidgetOptions: {
-                area: 'main',
-            }
-        });
-    }
-
-    async onStart(app: FrontendApplication): Promise<void> {
-        this.stateService.reachedState('ready').then(async () => {
-            if (this.editorManager.all.length === 0) {
-                await this.preferenceService.ready;
-                const startupEditor = this.preferenceService.get('workbench.startupEditor');
-                switch (startupEditor) {
-                    case 'welcomePage':
-                        this.openView({ reveal: true, activate: true });
-                        break;
-                    case 'welcomePageInEmptyWorkbench':
-                        if (!this.workspaceService.opened) {
-                            this.openView({ reveal: true, activate: true });
-                        }
-                        break;
-                    case 'newUntitledFile':
-                        this.commandRegistry.executeCommand(CommonCommands.NEW_UNTITLED_TEXT_FILE.id);
-                        break;
-                    case 'readme':
-                        await this.openReadme();
-                        break;
-                }
-            }
-        });
-    }
-
-    protected async openReadme(): Promise<void> {
-        const roots = await this.workspaceService.roots;
-        const readmes = await Promise.all(roots.map(async folder => {
-            const folderStat = await this.fileService.resolve(folder.resource);
-            const fileArr = folderStat?.children?.sort((a, b) => a.name.localeCompare(b.name)) || [];
-            const filePath = fileArr.find(file => file.name.toLowerCase() === 'readme.md') || fileArr.find(file => file.name.toLowerCase().startsWith('readme'));
-            return filePath?.resource;
-        }));
-        const validReadmes = ArrayUtils.coalesce(readmes);
-        if (validReadmes.length) {
-            for (const readme of validReadmes) {
-                await this.previewContribution.open(readme);
-            }
-        } else {
-            // If no readme is found, show the welcome page.
-            this.openView({ reveal: true, activate: true });
-        }
-    }
-
-    override registerCommands(registry: CommandRegistry): void {
-        registry.registerCommand(GettingStartedCommand, {
-            execute: () => this.openView({ reveal: true, activate: true }),
-        });
-    }
-
-    override registerMenus(menus: MenuModelRegistry): void {
-        menus.registerMenuAction(CommonMenus.HELP, {
-            commandId: GettingStartedCommand.id,
-            label: GettingStartedCommand.label,
-            order: 'a10'
-        });
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2018 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 { injectable, inject } from '@theia/core/shared/inversify';
+import { ArrayUtils, CommandRegistry, MenuModelRegistry } from '@theia/core/lib/common';
+import { CommonCommands, CommonMenus, AbstractViewContribution, FrontendApplicationContribution, FrontendApplication, PreferenceService } from '@theia/core/lib/browser';
+import { EditorManager } from '@theia/editor/lib/browser/editor-manager';
+import { GettingStartedWidget } from './getting-started-widget';
+import { FileService } from '@theia/filesystem/lib/browser/file-service';
+import { FrontendApplicationStateService } from '@theia/core/lib/browser/frontend-application-state';
+import { PreviewContribution } from '@theia/preview/lib/browser/preview-contribution';
+import { WorkspaceService } from '@theia/workspace/lib/browser';
+
+/**
+ * Triggers opening the `GettingStartedWidget`.
+ */
+export const GettingStartedCommand = {
+    id: GettingStartedWidget.ID,
+    label: GettingStartedWidget.LABEL
+};
+
+@injectable()
+export class GettingStartedContribution extends AbstractViewContribution<GettingStartedWidget> implements FrontendApplicationContribution {
+
+    @inject(CommandRegistry)
+    protected readonly commandRegistry: CommandRegistry;
+
+    @inject(EditorManager)
+    protected readonly editorManager: EditorManager;
+
+    @inject(FileService)
+    protected readonly fileService: FileService;
+
+    @inject(PreferenceService)
+    protected readonly preferenceService: PreferenceService;
+
+    @inject(PreviewContribution)
+    protected readonly previewContribution: PreviewContribution;
+
+    @inject(FrontendApplicationStateService)
+    protected readonly stateService: FrontendApplicationStateService;
+
+    @inject(WorkspaceService)
+    protected readonly workspaceService: WorkspaceService;
+
+    constructor() {
+        super({
+            widgetId: GettingStartedWidget.ID,
+            widgetName: GettingStartedWidget.LABEL,
+            defaultWidgetOptions: {
+                area: 'main',
+            }
+        });
+    }
+
+    async onStart(app: FrontendApplication): Promise<void> {
+        this.stateService.reachedState('ready').then(async () => {
+            if (this.editorManager.all.length === 0) {
+                await this.preferenceService.ready;
+                const startupEditor = this.preferenceService.get('workbench.startupEditor');
+                switch (startupEditor) {
+                    case 'welcomePage':
+                        this.openView({ reveal: true, activate: true });
+                        break;
+                    case 'welcomePageInEmptyWorkbench':
+                        if (!this.workspaceService.opened) {
+                            this.openView({ reveal: true, activate: true });
+                        }
+                        break;
+                    case 'newUntitledFile':
+                        this.commandRegistry.executeCommand(CommonCommands.NEW_UNTITLED_TEXT_FILE.id);
+                        break;
+                    case 'readme':
+                        await this.openReadme();
+                        break;
+                }
+            }
+        });
+    }
+
+    protected async openReadme(): Promise<void> {
+        const roots = await this.workspaceService.roots;
+        const readmes = await Promise.all(roots.map(async folder => {
+            const folderStat = await this.fileService.resolve(folder.resource);
+            const fileArr = folderStat?.children?.sort((a, b) => a.name.localeCompare(b.name)) || [];
+            const filePath = fileArr.find(file => file.name.toLowerCase() === 'readme.md') || fileArr.find(file => file.name.toLowerCase().startsWith('readme'));
+            return filePath?.resource;
+        }));
+        const validReadmes = ArrayUtils.coalesce(readmes);
+        if (validReadmes.length) {
+            for (const readme of validReadmes) {
+                await this.previewContribution.open(readme);
+            }
+        } else {
+            // If no readme is found, show the welcome page.
+            this.openView({ reveal: true, activate: true });
+        }
+    }
+
+    override registerCommands(registry: CommandRegistry): void {
+        registry.registerCommand(GettingStartedCommand, {
+            execute: () => this.openView({ reveal: true, activate: true }),
+        });
+    }
+
+    override registerMenus(menus: MenuModelRegistry): void {
+        menus.registerMenuAction(CommonMenus.HELP, {
+            commandId: GettingStartedCommand.id,
+            label: GettingStartedCommand.label,
+            order: 'a10'
+        });
+    }
+}

package/src/browser/getting-started-frontend-module.ts

@@ -1,33 +1,33 @@
-// *****************************************************************************
-// Copyright (C) 2018 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 { GettingStartedContribution } from './getting-started-contribution';
-import { ContainerModule, interfaces } from '@theia/core/shared/inversify';
-import { GettingStartedWidget } from './getting-started-widget';
-import { WidgetFactory, FrontendApplicationContribution, bindViewContribution } from '@theia/core/lib/browser';
-import { bindGettingStartedPreferences } from './getting-started-preferences';
-import '../../src/browser/style/index.css';
-
-export default new ContainerModule((bind: interfaces.Bind) => {
-    bindViewContribution(bind, GettingStartedContribution);
-    bind(FrontendApplicationContribution).toService(GettingStartedContribution);
-    bind(GettingStartedWidget).toSelf();
-    bind(WidgetFactory).toDynamicValue(context => ({
-        id: GettingStartedWidget.ID,
-        createWidget: () => context.container.get<GettingStartedWidget>(GettingStartedWidget),
-    })).inSingletonScope();
-    bindGettingStartedPreferences(bind);
-});
+// *****************************************************************************
+// Copyright (C) 2018 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 { GettingStartedContribution } from './getting-started-contribution';
+import { ContainerModule, interfaces } from '@theia/core/shared/inversify';
+import { GettingStartedWidget } from './getting-started-widget';
+import { WidgetFactory, FrontendApplicationContribution, bindViewContribution } from '@theia/core/lib/browser';
+import { bindGettingStartedPreferences } from './getting-started-preferences';
+import '../../src/browser/style/index.css';
+
+export default new ContainerModule((bind: interfaces.Bind) => {
+    bindViewContribution(bind, GettingStartedContribution);
+    bind(FrontendApplicationContribution).toService(GettingStartedContribution);
+    bind(GettingStartedWidget).toSelf();
+    bind(WidgetFactory).toDynamicValue(context => ({
+        id: GettingStartedWidget.ID,
+        createWidget: () => context.container.get<GettingStartedWidget>(GettingStartedWidget),
+    })).inSingletonScope();
+    bindGettingStartedPreferences(bind);
+});

package/src/browser/getting-started-preferences.ts

@@ -1,69 +1,69 @@
-// *****************************************************************************
-// Copyright (C) 2023 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,
-    PreferenceSchema,
-    PreferenceContribution
-} from '@theia/core/lib/browser/preferences';
-import { FrontendApplicationConfigProvider } from '@theia/core/lib/browser/frontend-application-config-provider';
-import { nls } from '@theia/core/lib/common/nls';
-
-export const GettingStartedPreferenceSchema: PreferenceSchema = {
-    'type': 'object',
-    properties: {
-        'workbench.startupEditor': {
-            type: 'string',
-            enum: ['none', 'welcomePage', 'readme', 'newUntitledFile', 'welcomePageInEmptyWorkbench'],
-            enumDescriptions: [
-                nls.localizeByDefault('Start without an editor.'),
-                nls.localize('theia/getting-started/startup-editor/welcomePage', 'Open the Welcome page, with content to aid in getting started with {0} and extensions.',
-                    FrontendApplicationConfigProvider.get().applicationName),
-                // eslint-disable-next-line max-len
-                nls.localizeByDefault("Open the README when opening a folder that contains one, fallback to 'welcomePage' otherwise. Note: This is only observed as a global configuration, it will be ignored if set in a workspace or folder configuration."),
-                nls.localizeByDefault('Open a new untitled text file (only applies when opening an empty window).'),
-                nls.localizeByDefault('Open the Welcome page when opening an empty workbench.'),
-            ],
-            default: 'welcomePage',
-            description: nls.localizeByDefault('Controls which editor is shown at startup, if none are restored from the previous session.')
-        },
-    }
-};
-
-export interface GettingStartedConfiguration {
-    'workbench.startupEditor': string;
-}
-
-export const GettingStartedPreferenceContribution = Symbol('GettingStartedPreferenceContribution');
-export const GettingStartedPreferences = Symbol('GettingStartedPreferences');
-export type GettingStartedPreferences = PreferenceProxy<GettingStartedConfiguration>;
-
-export function createGettingStartedPreferences(preferences: PreferenceService, schema: PreferenceSchema = GettingStartedPreferenceSchema): GettingStartedPreferences {
-    return createPreferenceProxy(preferences, schema);
-}
-
-export function bindGettingStartedPreferences(bind: interfaces.Bind): void {
-    bind(GettingStartedPreferences).toDynamicValue(ctx => {
-        const preferences = ctx.container.get<PreferenceService>(PreferenceService);
-        const contribution = ctx.container.get<PreferenceContribution>(GettingStartedPreferenceContribution);
-        return createGettingStartedPreferences(preferences, contribution.schema);
-    }).inSingletonScope();
-    bind(GettingStartedPreferenceContribution).toConstantValue({ schema: GettingStartedPreferenceSchema });
-    bind(PreferenceContribution).toService(GettingStartedPreferenceContribution);
-}
+// *****************************************************************************
+// Copyright (C) 2023 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,
+    PreferenceSchema,
+    PreferenceContribution
+} from '@theia/core/lib/browser/preferences';
+import { FrontendApplicationConfigProvider } from '@theia/core/lib/browser/frontend-application-config-provider';
+import { nls } from '@theia/core/lib/common/nls';
+
+export const GettingStartedPreferenceSchema: PreferenceSchema = {
+    'type': 'object',
+    properties: {
+        'workbench.startupEditor': {
+            type: 'string',
+            enum: ['none', 'welcomePage', 'readme', 'newUntitledFile', 'welcomePageInEmptyWorkbench'],
+            enumDescriptions: [
+                nls.localizeByDefault('Start without an editor.'),
+                nls.localize('theia/getting-started/startup-editor/welcomePage', 'Open the Welcome page, with content to aid in getting started with {0} and extensions.',
+                    FrontendApplicationConfigProvider.get().applicationName),
+                // eslint-disable-next-line max-len
+                nls.localizeByDefault("Open the README when opening a folder that contains one, fallback to 'welcomePage' otherwise. Note: This is only observed as a global configuration, it will be ignored if set in a workspace or folder configuration."),
+                nls.localizeByDefault('Open a new untitled text file (only applies when opening an empty window).'),
+                nls.localizeByDefault('Open the Welcome page when opening an empty workbench.'),
+            ],
+            default: 'welcomePage',
+            description: nls.localizeByDefault('Controls which editor is shown at startup, if none are restored from the previous session.')
+        },
+    }
+};
+
+export interface GettingStartedConfiguration {
+    'workbench.startupEditor': string;
+}
+
+export const GettingStartedPreferenceContribution = Symbol('GettingStartedPreferenceContribution');
+export const GettingStartedPreferences = Symbol('GettingStartedPreferences');
+export type GettingStartedPreferences = PreferenceProxy<GettingStartedConfiguration>;
+
+export function createGettingStartedPreferences(preferences: PreferenceService, schema: PreferenceSchema = GettingStartedPreferenceSchema): GettingStartedPreferences {
+    return createPreferenceProxy(preferences, schema);
+}
+
+export function bindGettingStartedPreferences(bind: interfaces.Bind): void {
+    bind(GettingStartedPreferences).toDynamicValue(ctx => {
+        const preferences = ctx.container.get<PreferenceService>(PreferenceService);
+        const contribution = ctx.container.get<PreferenceContribution>(GettingStartedPreferenceContribution);
+        return createGettingStartedPreferences(preferences, contribution.schema);
+    }).inSingletonScope();
+    bind(GettingStartedPreferenceContribution).toConstantValue({ schema: GettingStartedPreferenceSchema });
+    bind(PreferenceContribution).toService(GettingStartedPreferenceContribution);
+}