@theia/getting-started 1.45.0 → 1.46.0-next.72

package/lib/browser/getting-started-preferences.js

@@ -1,57 +1,57 @@
-"use strict";
-// *****************************************************************************
-// 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
-// *****************************************************************************
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.bindGettingStartedPreferences = exports.createGettingStartedPreferences = exports.GettingStartedPreferences = exports.GettingStartedPreferenceContribution = exports.GettingStartedPreferenceSchema = void 0;
-const preferences_1 = require("@theia/core/lib/browser/preferences");
-const frontend_application_config_provider_1 = require("@theia/core/lib/browser/frontend-application-config-provider");
-const nls_1 = require("@theia/core/lib/common/nls");
-exports.GettingStartedPreferenceSchema = {
-    'type': 'object',
-    properties: {
-        'workbench.startupEditor': {
-            type: 'string',
-            enum: ['none', 'welcomePage', 'readme', 'newUntitledFile', 'welcomePageInEmptyWorkbench'],
-            enumDescriptions: [
-                nls_1.nls.localizeByDefault('Start without an editor.'),
-                nls_1.nls.localize('theia/getting-started/startup-editor/welcomePage', 'Open the Welcome page, with content to aid in getting started with {0} and extensions.', frontend_application_config_provider_1.FrontendApplicationConfigProvider.get().applicationName),
-                // eslint-disable-next-line max-len
-                nls_1.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_1.nls.localizeByDefault('Open a new untitled text file (only applies when opening an empty window).'),
-                nls_1.nls.localizeByDefault('Open the Welcome page when opening an empty workbench.'),
-            ],
-            default: 'welcomePage',
-            description: nls_1.nls.localizeByDefault('Controls which editor is shown at startup, if none are restored from the previous session.')
-        },
-    }
-};
-exports.GettingStartedPreferenceContribution = Symbol('GettingStartedPreferenceContribution');
-exports.GettingStartedPreferences = Symbol('GettingStartedPreferences');
-function createGettingStartedPreferences(preferences, schema = exports.GettingStartedPreferenceSchema) {
-    return (0, preferences_1.createPreferenceProxy)(preferences, schema);
-}
-exports.createGettingStartedPreferences = createGettingStartedPreferences;
-function bindGettingStartedPreferences(bind) {
-    bind(exports.GettingStartedPreferences).toDynamicValue(ctx => {
-        const preferences = ctx.container.get(preferences_1.PreferenceService);
-        const contribution = ctx.container.get(exports.GettingStartedPreferenceContribution);
-        return createGettingStartedPreferences(preferences, contribution.schema);
-    }).inSingletonScope();
-    bind(exports.GettingStartedPreferenceContribution).toConstantValue({ schema: exports.GettingStartedPreferenceSchema });
-    bind(preferences_1.PreferenceContribution).toService(exports.GettingStartedPreferenceContribution);
-}
-exports.bindGettingStartedPreferences = bindGettingStartedPreferences;
+"use strict";
+// *****************************************************************************
+// 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
+// *****************************************************************************
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.bindGettingStartedPreferences = exports.createGettingStartedPreferences = exports.GettingStartedPreferences = exports.GettingStartedPreferenceContribution = exports.GettingStartedPreferenceSchema = void 0;
+const preferences_1 = require("@theia/core/lib/browser/preferences");
+const frontend_application_config_provider_1 = require("@theia/core/lib/browser/frontend-application-config-provider");
+const nls_1 = require("@theia/core/lib/common/nls");
+exports.GettingStartedPreferenceSchema = {
+    'type': 'object',
+    properties: {
+        'workbench.startupEditor': {
+            type: 'string',
+            enum: ['none', 'welcomePage', 'readme', 'newUntitledFile', 'welcomePageInEmptyWorkbench'],
+            enumDescriptions: [
+                nls_1.nls.localizeByDefault('Start without an editor.'),
+                nls_1.nls.localize('theia/getting-started/startup-editor/welcomePage', 'Open the Welcome page, with content to aid in getting started with {0} and extensions.', frontend_application_config_provider_1.FrontendApplicationConfigProvider.get().applicationName),
+                // eslint-disable-next-line max-len
+                nls_1.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_1.nls.localizeByDefault('Open a new untitled text file (only applies when opening an empty window).'),
+                nls_1.nls.localizeByDefault('Open the Welcome page when opening an empty workbench.'),
+            ],
+            default: 'welcomePage',
+            description: nls_1.nls.localizeByDefault('Controls which editor is shown at startup, if none are restored from the previous session.')
+        },
+    }
+};
+exports.GettingStartedPreferenceContribution = Symbol('GettingStartedPreferenceContribution');
+exports.GettingStartedPreferences = Symbol('GettingStartedPreferences');
+function createGettingStartedPreferences(preferences, schema = exports.GettingStartedPreferenceSchema) {
+    return (0, preferences_1.createPreferenceProxy)(preferences, schema);
+}
+exports.createGettingStartedPreferences = createGettingStartedPreferences;
+function bindGettingStartedPreferences(bind) {
+    bind(exports.GettingStartedPreferences).toDynamicValue(ctx => {
+        const preferences = ctx.container.get(preferences_1.PreferenceService);
+        const contribution = ctx.container.get(exports.GettingStartedPreferenceContribution);
+        return createGettingStartedPreferences(preferences, contribution.schema);
+    }).inSingletonScope();
+    bind(exports.GettingStartedPreferenceContribution).toConstantValue({ schema: exports.GettingStartedPreferenceSchema });
+    bind(preferences_1.PreferenceContribution).toService(exports.GettingStartedPreferenceContribution);
+}
+exports.bindGettingStartedPreferences = bindGettingStartedPreferences;
 //# sourceMappingURL=getting-started-preferences.js.map

package/lib/browser/getting-started-widget.d.ts

@@ -1,157 +1,157 @@
-/// <reference types="react" />
-import * as React from '@theia/core/shared/react';
-import URI from '@theia/core/lib/common/uri';
-import { CommandRegistry } from '@theia/core/lib/common';
-import { WorkspaceService } from '@theia/workspace/lib/browser';
-import { Message, ReactWidget, LabelProvider, PreferenceService } from '@theia/core/lib/browser';
-import { ApplicationInfo, ApplicationServer } from '@theia/core/lib/common/application-protocol';
-import { EnvVariablesServer } from '@theia/core/lib/common/env-variables';
-import { WindowService } from '@theia/core/lib/browser/window/window-service';
-/**
- * Default implementation of the `GettingStartedWidget`.
- * The widget is displayed when there are currently no workspaces present.
- * Some of the features displayed include:
- * - `open` commands.
- * - `recently used workspaces`.
- * - `settings` commands.
- * - `help` commands.
- * - helpful links.
- */
-export declare class GettingStartedWidget extends ReactWidget {
-    /**
-     * The widget `id`.
-     */
-    static readonly ID = "getting.started.widget";
-    /**
-     * The widget `label` which is used for display purposes.
-     */
-    static readonly LABEL: string;
-    /**
-     * The `ApplicationInfo` for the application if available.
-     * Used in order to obtain the version number of the application.
-     */
-    protected applicationInfo: ApplicationInfo | undefined;
-    /**
-     * The application name which is used for display purposes.
-     */
-    protected applicationName: string;
-    protected home: string | undefined;
-    /**
-     * The recently used workspaces limit.
-     * Used in order to limit the number of recently used workspaces to display.
-     */
-    protected recentLimit: number;
-    /**
-     * The list of recently used workspaces.
-     */
-    protected recentWorkspaces: string[];
-    /**
-     * Collection of useful links to display for end users.
-     */
-    protected readonly documentationUrl = "https://www.theia-ide.org/docs/";
-    protected readonly compatibilityUrl = "https://eclipse-theia.github.io/vscode-theia-comparator/status.html";
-    protected readonly extensionUrl = "https://www.theia-ide.org/docs/authoring_extensions";
-    protected readonly pluginUrl = "https://www.theia-ide.org/docs/authoring_plugins";
-    protected readonly appServer: ApplicationServer;
-    protected readonly commandRegistry: CommandRegistry;
-    protected readonly environments: EnvVariablesServer;
-    protected readonly labelProvider: LabelProvider;
-    protected readonly windowService: WindowService;
-    protected readonly workspaceService: WorkspaceService;
-    protected readonly preferenceService: PreferenceService;
-    protected init(): void;
-    protected doInit(): Promise<void>;
-    protected onActivateRequest(msg: Message): void;
-    /**
-     * Render the content of the widget.
-     */
-    protected render(): React.ReactNode;
-    /**
-     * Render the widget header.
-     * Renders the title `{applicationName} Getting Started`.
-     */
-    protected renderHeader(): React.ReactNode;
-    /**
-     * Render the `open` section.
-     * Displays a collection of `open` commands.
-     */
-    protected renderOpen(): React.ReactNode;
-    /**
-     * Render the recently used workspaces section.
-     */
-    protected renderRecentWorkspaces(): React.ReactNode;
-    /**
-     * Render the settings section.
-     * Generally used to display useful links.
-     */
-    protected renderSettings(): React.ReactNode;
-    /**
-     * Render the help section.
-     */
-    protected renderHelp(): React.ReactNode;
-    /**
-     * Render the version section.
-     */
-    protected renderVersion(): React.ReactNode;
-    protected renderPreferences(): React.ReactNode;
-    /**
-     * Build the list of workspace paths.
-     * @param workspaces {string[]} the list of workspaces.
-     * @returns {string[]} the list of workspace paths.
-     */
-    protected buildPaths(workspaces: string[]): string[];
-    /**
-     * Trigger the open command.
-     */
-    protected doOpen: () => Promise<unknown>;
-    protected doOpenEnter: (e: React.KeyboardEvent) => void;
-    /**
-     * Trigger the open file command.
-     */
-    protected doOpenFile: () => Promise<unknown>;
-    protected doOpenFileEnter: (e: React.KeyboardEvent) => void;
-    /**
-     * Trigger the open folder command.
-     */
-    protected doOpenFolder: () => Promise<unknown>;
-    protected doOpenFolderEnter: (e: React.KeyboardEvent) => void;
-    /**
-     * Trigger the open workspace command.
-     */
-    protected doOpenWorkspace: () => Promise<unknown>;
-    protected doOpenWorkspaceEnter: (e: React.KeyboardEvent) => void;
-    /**
-     * Trigger the open recent workspace command.
-     */
-    protected doOpenRecentWorkspace: () => Promise<unknown>;
-    protected doOpenRecentWorkspaceEnter: (e: React.KeyboardEvent) => void;
-    /**
-     * Trigger the open preferences command.
-     * Used to open the preferences widget.
-     */
-    protected doOpenPreferences: () => Promise<unknown>;
-    protected doOpenPreferencesEnter: (e: React.KeyboardEvent) => void;
-    /**
-     * Trigger the open keyboard shortcuts command.
-     * Used to open the keyboard shortcuts widget.
-     */
-    protected doOpenKeyboardShortcuts: () => Promise<unknown>;
-    protected doOpenKeyboardShortcutsEnter: (e: React.KeyboardEvent) => void;
-    /**
-     * Open a workspace given its uri.
-     * @param uri {URI} the workspace uri.
-     */
-    protected open: (uri: URI) => void;
-    protected openEnter: (e: React.KeyboardEvent, uri: URI) => void;
-    /**
-     * Open a link in an external window.
-     * @param url the link.
-     */
-    protected doOpenExternalLink: (url: string) => undefined;
-    protected doOpenExternalLinkEnter: (e: React.KeyboardEvent, url: string) => void;
-    protected isEnterKey(e: React.KeyboardEvent): boolean;
-}
-export interface PreferencesProps {
-    preferenceService: PreferenceService;
-}
+/// <reference types="react" />
+import * as React from '@theia/core/shared/react';
+import URI from '@theia/core/lib/common/uri';
+import { CommandRegistry } from '@theia/core/lib/common';
+import { WorkspaceService } from '@theia/workspace/lib/browser';
+import { Message, ReactWidget, LabelProvider, PreferenceService } from '@theia/core/lib/browser';
+import { ApplicationInfo, ApplicationServer } from '@theia/core/lib/common/application-protocol';
+import { EnvVariablesServer } from '@theia/core/lib/common/env-variables';
+import { WindowService } from '@theia/core/lib/browser/window/window-service';
+/**
+ * Default implementation of the `GettingStartedWidget`.
+ * The widget is displayed when there are currently no workspaces present.
+ * Some of the features displayed include:
+ * - `open` commands.
+ * - `recently used workspaces`.
+ * - `settings` commands.
+ * - `help` commands.
+ * - helpful links.
+ */
+export declare class GettingStartedWidget extends ReactWidget {
+    /**
+     * The widget `id`.
+     */
+    static readonly ID = "getting.started.widget";
+    /**
+     * The widget `label` which is used for display purposes.
+     */
+    static readonly LABEL: string;
+    /**
+     * The `ApplicationInfo` for the application if available.
+     * Used in order to obtain the version number of the application.
+     */
+    protected applicationInfo: ApplicationInfo | undefined;
+    /**
+     * The application name which is used for display purposes.
+     */
+    protected applicationName: string;
+    protected home: string | undefined;
+    /**
+     * The recently used workspaces limit.
+     * Used in order to limit the number of recently used workspaces to display.
+     */
+    protected recentLimit: number;
+    /**
+     * The list of recently used workspaces.
+     */
+    protected recentWorkspaces: string[];
+    /**
+     * Collection of useful links to display for end users.
+     */
+    protected readonly documentationUrl = "https://www.theia-ide.org/docs/";
+    protected readonly compatibilityUrl = "https://eclipse-theia.github.io/vscode-theia-comparator/status.html";
+    protected readonly extensionUrl = "https://www.theia-ide.org/docs/authoring_extensions";
+    protected readonly pluginUrl = "https://www.theia-ide.org/docs/authoring_plugins";
+    protected readonly appServer: ApplicationServer;
+    protected readonly commandRegistry: CommandRegistry;
+    protected readonly environments: EnvVariablesServer;
+    protected readonly labelProvider: LabelProvider;
+    protected readonly windowService: WindowService;
+    protected readonly workspaceService: WorkspaceService;
+    protected readonly preferenceService: PreferenceService;
+    protected init(): void;
+    protected doInit(): Promise<void>;
+    protected onActivateRequest(msg: Message): void;
+    /**
+     * Render the content of the widget.
+     */
+    protected render(): React.ReactNode;
+    /**
+     * Render the widget header.
+     * Renders the title `{applicationName} Getting Started`.
+     */
+    protected renderHeader(): React.ReactNode;
+    /**
+     * Render the `open` section.
+     * Displays a collection of `open` commands.
+     */
+    protected renderOpen(): React.ReactNode;
+    /**
+     * Render the recently used workspaces section.
+     */
+    protected renderRecentWorkspaces(): React.ReactNode;
+    /**
+     * Render the settings section.
+     * Generally used to display useful links.
+     */
+    protected renderSettings(): React.ReactNode;
+    /**
+     * Render the help section.
+     */
+    protected renderHelp(): React.ReactNode;
+    /**
+     * Render the version section.
+     */
+    protected renderVersion(): React.ReactNode;
+    protected renderPreferences(): React.ReactNode;
+    /**
+     * Build the list of workspace paths.
+     * @param workspaces {string[]} the list of workspaces.
+     * @returns {string[]} the list of workspace paths.
+     */
+    protected buildPaths(workspaces: string[]): string[];
+    /**
+     * Trigger the open command.
+     */
+    protected doOpen: () => Promise<unknown>;
+    protected doOpenEnter: (e: React.KeyboardEvent) => void;
+    /**
+     * Trigger the open file command.
+     */
+    protected doOpenFile: () => Promise<unknown>;
+    protected doOpenFileEnter: (e: React.KeyboardEvent) => void;
+    /**
+     * Trigger the open folder command.
+     */
+    protected doOpenFolder: () => Promise<unknown>;
+    protected doOpenFolderEnter: (e: React.KeyboardEvent) => void;
+    /**
+     * Trigger the open workspace command.
+     */
+    protected doOpenWorkspace: () => Promise<unknown>;
+    protected doOpenWorkspaceEnter: (e: React.KeyboardEvent) => void;
+    /**
+     * Trigger the open recent workspace command.
+     */
+    protected doOpenRecentWorkspace: () => Promise<unknown>;
+    protected doOpenRecentWorkspaceEnter: (e: React.KeyboardEvent) => void;
+    /**
+     * Trigger the open preferences command.
+     * Used to open the preferences widget.
+     */
+    protected doOpenPreferences: () => Promise<unknown>;
+    protected doOpenPreferencesEnter: (e: React.KeyboardEvent) => void;
+    /**
+     * Trigger the open keyboard shortcuts command.
+     * Used to open the keyboard shortcuts widget.
+     */
+    protected doOpenKeyboardShortcuts: () => Promise<unknown>;
+    protected doOpenKeyboardShortcutsEnter: (e: React.KeyboardEvent) => void;
+    /**
+     * Open a workspace given its uri.
+     * @param uri {URI} the workspace uri.
+     */
+    protected open: (uri: URI) => void;
+    protected openEnter: (e: React.KeyboardEvent, uri: URI) => void;
+    /**
+     * Open a link in an external window.
+     * @param url the link.
+     */
+    protected doOpenExternalLink: (url: string) => undefined;
+    protected doOpenExternalLinkEnter: (e: React.KeyboardEvent, url: string) => void;
+    protected isEnterKey(e: React.KeyboardEvent): boolean;
+}
+export interface PreferencesProps {
+    preferenceService: PreferenceService;
+}
 //# sourceMappingURL=getting-started-widget.d.ts.map