@theia/terminal 1.45.0 → 1.46.0-next.72

package/src/node/buffering-stream.ts

@@ -1,95 +1,95 @@
-// *****************************************************************************
-// Copyright (C) 2022 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 { Emitter, Event } from '@theia/core/lib/common/event';
-
-export interface BufferingStreamOptions {
-    /**
-     * Max size in bytes of the chunks being emitted.
-     */
-    maxChunkSize?: number
-    /**
-     * Amount of time in milliseconds to wait between the moment we start
-     * buffering data and when we emit the buffered chunk.
-     */
-    emitInterval?: number
-}
-
-/**
- * This component will buffer whatever is pushed to it and emit chunks back
- * every {@link BufferingStreamOptions.emitInterval}. It will also ensure that
- * the emitted chunks never exceed {@link BufferingStreamOptions.maxChunkSize}.
- */
-export class BufferingStream<T> {
-    protected buffer?: T;
-    protected timeout?: NodeJS.Timeout;
-    protected maxChunkSize: number;
-    protected emitInterval: number;
-
-    protected onDataEmitter = new Emitter<T>();
-    protected readonly concat: (left: T, right: T) => T;
-    protected readonly slice: (what: T, start?: number, end?: number) => T;
-    protected readonly length: (what: T) => number;
-
-    constructor(options: BufferingStreamOptions = {}, concat: (left: T, right: T) => T, slice: (what: T, start?: number, end?: number) => T, length: (what: T) => number) {
-        this.emitInterval = options.emitInterval ?? 16; // ms
-        this.maxChunkSize = options.maxChunkSize ?? (256 * 1024); // bytes
-        this.concat = concat;
-        this.slice = slice;
-        this.length = length;
-    }
-
-    get onData(): Event<T> {
-        return this.onDataEmitter.event;
-    }
-
-    push(chunk: T): void {
-        if (this.buffer) {
-            this.buffer = this.concat(this.buffer, chunk);
-        } else {
-            this.buffer = chunk;
-            this.timeout = setTimeout(() => this.emitBufferedChunk(), this.emitInterval);
-        }
-    }
-
-    dispose(): void {
-        clearTimeout(this.timeout);
-        this.buffer = undefined;
-        this.onDataEmitter.dispose();
-    }
-
-    protected emitBufferedChunk(): void {
-        this.onDataEmitter.fire(this.slice(this.buffer!, 0, this.maxChunkSize));
-        if (this.length(this.buffer!) <= this.maxChunkSize) {
-            this.buffer = undefined;
-        } else {
-            this.buffer = this.slice(this.buffer!, this.maxChunkSize);
-            this.timeout = setTimeout(() => this.emitBufferedChunk(), this.emitInterval);
-        }
-    }
-}
-
-export class StringBufferingStream extends BufferingStream<string> {
-    constructor(options: BufferingStreamOptions = {}) {
-        super(options, (left, right) => left.concat(right), (what, start, end) => what.slice(start, end), what => what.length);
-    }
-}
-
-export class BufferBufferingStream extends BufferingStream<Buffer> {
-    constructor(options: BufferingStreamOptions = {}) {
-        super(options, (left, right) => Buffer.concat([left, right]), (what, start, end) => what.slice(start, end), what => what.length);
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2022 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 { Emitter, Event } from '@theia/core/lib/common/event';
+
+export interface BufferingStreamOptions {
+    /**
+     * Max size in bytes of the chunks being emitted.
+     */
+    maxChunkSize?: number
+    /**
+     * Amount of time in milliseconds to wait between the moment we start
+     * buffering data and when we emit the buffered chunk.
+     */
+    emitInterval?: number
+}
+
+/**
+ * This component will buffer whatever is pushed to it and emit chunks back
+ * every {@link BufferingStreamOptions.emitInterval}. It will also ensure that
+ * the emitted chunks never exceed {@link BufferingStreamOptions.maxChunkSize}.
+ */
+export class BufferingStream<T> {
+    protected buffer?: T;
+    protected timeout?: NodeJS.Timeout;
+    protected maxChunkSize: number;
+    protected emitInterval: number;
+
+    protected onDataEmitter = new Emitter<T>();
+    protected readonly concat: (left: T, right: T) => T;
+    protected readonly slice: (what: T, start?: number, end?: number) => T;
+    protected readonly length: (what: T) => number;
+
+    constructor(options: BufferingStreamOptions = {}, concat: (left: T, right: T) => T, slice: (what: T, start?: number, end?: number) => T, length: (what: T) => number) {
+        this.emitInterval = options.emitInterval ?? 16; // ms
+        this.maxChunkSize = options.maxChunkSize ?? (256 * 1024); // bytes
+        this.concat = concat;
+        this.slice = slice;
+        this.length = length;
+    }
+
+    get onData(): Event<T> {
+        return this.onDataEmitter.event;
+    }
+
+    push(chunk: T): void {
+        if (this.buffer) {
+            this.buffer = this.concat(this.buffer, chunk);
+        } else {
+            this.buffer = chunk;
+            this.timeout = setTimeout(() => this.emitBufferedChunk(), this.emitInterval);
+        }
+    }
+
+    dispose(): void {
+        clearTimeout(this.timeout);
+        this.buffer = undefined;
+        this.onDataEmitter.dispose();
+    }
+
+    protected emitBufferedChunk(): void {
+        this.onDataEmitter.fire(this.slice(this.buffer!, 0, this.maxChunkSize));
+        if (this.length(this.buffer!) <= this.maxChunkSize) {
+            this.buffer = undefined;
+        } else {
+            this.buffer = this.slice(this.buffer!, this.maxChunkSize);
+            this.timeout = setTimeout(() => this.emitBufferedChunk(), this.emitInterval);
+        }
+    }
+}
+
+export class StringBufferingStream extends BufferingStream<string> {
+    constructor(options: BufferingStreamOptions = {}) {
+        super(options, (left, right) => left.concat(right), (what, start, end) => what.slice(start, end), what => what.length);
+    }
+}
+
+export class BufferBufferingStream extends BufferingStream<Buffer> {
+    constructor(options: BufferingStreamOptions = {}) {
+        super(options, (left, right) => Buffer.concat([left, right]), (what, start, end) => what.slice(start, end), what => what.length);
+    }
+}

package/src/node/index.ts

@@ -1,17 +1,17 @@
-// *****************************************************************************
-// Copyright (C) 2017 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
-// *****************************************************************************
-
-export * from './terminal-backend-module';
+// *****************************************************************************
+// Copyright (C) 2017 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
+// *****************************************************************************
+
+export * from './terminal-backend-module';

package/src/node/shell-process.ts

@@ -1,101 +1,101 @@
-// *****************************************************************************
-// Copyright (C) 2017 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, named } from '@theia/core/shared/inversify';
-import * as os from 'os';
-import { ILogger } from '@theia/core/lib/common/logger';
-import { TerminalProcess, TerminalProcessOptions, ProcessManager, MultiRingBuffer } from '@theia/process/lib/node';
-import { isWindows, isOSX } from '@theia/core/lib/common';
-import URI from '@theia/core/lib/common/uri';
-import { FileUri } from '@theia/core/lib/node/file-uri';
-import { EnvironmentUtils } from '@theia/core/lib/node/environment-utils';
-import { parseArgs } from '@theia/process/lib/node/utils';
-
-export const ShellProcessFactory = Symbol('ShellProcessFactory');
-export type ShellProcessFactory = (options: ShellProcessOptions) => ShellProcess;
-
-export const ShellProcessOptions = Symbol('ShellProcessOptions');
-export interface ShellProcessOptions {
-    shell?: string,
-    args?: string[] | string,
-    rootURI?: string,
-    cols?: number,
-    rows?: number,
-    env?: { [key: string]: string | null },
-    strictEnv?: boolean,
-    isPseudo?: boolean,
-}
-
-export function getRootPath(rootURI?: string): string {
-    if (rootURI) {
-        const uri = new URI(rootURI);
-        return FileUri.fsPath(uri);
-    } else {
-        return os.homedir();
-    }
-}
-
-@injectable()
-export class ShellProcess extends TerminalProcess {
-
-    protected static defaultCols = 80;
-    protected static defaultRows = 24;
-
-    constructor( // eslint-disable-next-line @typescript-eslint/indent
-        @inject(ShellProcessOptions) options: ShellProcessOptions,
-        @inject(ProcessManager) processManager: ProcessManager,
-        @inject(MultiRingBuffer) ringBuffer: MultiRingBuffer,
-        @inject(ILogger) @named('terminal') logger: ILogger,
-        @inject(EnvironmentUtils) environmentUtils: EnvironmentUtils,
-    ) {
-        super(<TerminalProcessOptions>{
-            command: options.shell || ShellProcess.getShellExecutablePath(),
-            args: options.args || ShellProcess.getShellExecutableArgs(),
-            options: {
-                name: 'xterm-color',
-                cols: options.cols || ShellProcess.defaultCols,
-                rows: options.rows || ShellProcess.defaultRows,
-                cwd: getRootPath(options.rootURI),
-                env: options.strictEnv !== true ? environmentUtils.mergeProcessEnv(options.env) : options.env,
-            },
-            isPseudo: options.isPseudo,
-        }, processManager, ringBuffer, logger);
-    }
-
-    public static getShellExecutablePath(): string {
-        const shell = process.env.THEIA_SHELL;
-        if (shell) {
-            return shell;
-        }
-        if (isWindows) {
-            return 'cmd.exe';
-        } else {
-            return process.env.SHELL!;
-        }
-    }
-
-    public static getShellExecutableArgs(): string[] {
-        const args = process.env.THEIA_SHELL_ARGS;
-        if (args) {
-            return parseArgs(args);
-        }
-        if (isOSX) {
-            return ['-l'];
-        } else {
-            return [];
-        }
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2017 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, named } from '@theia/core/shared/inversify';
+import * as os from 'os';
+import { ILogger } from '@theia/core/lib/common/logger';
+import { TerminalProcess, TerminalProcessOptions, ProcessManager, MultiRingBuffer } from '@theia/process/lib/node';
+import { isWindows, isOSX } from '@theia/core/lib/common';
+import URI from '@theia/core/lib/common/uri';
+import { FileUri } from '@theia/core/lib/common/file-uri';
+import { EnvironmentUtils } from '@theia/core/lib/node/environment-utils';
+import { parseArgs } from '@theia/process/lib/node/utils';
+
+export const ShellProcessFactory = Symbol('ShellProcessFactory');
+export type ShellProcessFactory = (options: ShellProcessOptions) => ShellProcess;
+
+export const ShellProcessOptions = Symbol('ShellProcessOptions');
+export interface ShellProcessOptions {
+    shell?: string,
+    args?: string[] | string,
+    rootURI?: string,
+    cols?: number,
+    rows?: number,
+    env?: { [key: string]: string | null },
+    strictEnv?: boolean,
+    isPseudo?: boolean,
+}
+
+export function getRootPath(rootURI?: string): string {
+    if (rootURI) {
+        const uri = new URI(rootURI);
+        return FileUri.fsPath(uri);
+    } else {
+        return os.homedir();
+    }
+}
+
+@injectable()
+export class ShellProcess extends TerminalProcess {
+
+    protected static defaultCols = 80;
+    protected static defaultRows = 24;
+
+    constructor( // eslint-disable-next-line @typescript-eslint/indent
+        @inject(ShellProcessOptions) options: ShellProcessOptions,
+        @inject(ProcessManager) processManager: ProcessManager,
+        @inject(MultiRingBuffer) ringBuffer: MultiRingBuffer,
+        @inject(ILogger) @named('terminal') logger: ILogger,
+        @inject(EnvironmentUtils) environmentUtils: EnvironmentUtils,
+    ) {
+        super(<TerminalProcessOptions>{
+            command: options.shell || ShellProcess.getShellExecutablePath(),
+            args: options.args || ShellProcess.getShellExecutableArgs(),
+            options: {
+                name: 'xterm-color',
+                cols: options.cols || ShellProcess.defaultCols,
+                rows: options.rows || ShellProcess.defaultRows,
+                cwd: getRootPath(options.rootURI),
+                env: options.strictEnv !== true ? environmentUtils.mergeProcessEnv(options.env) : options.env,
+            },
+            isPseudo: options.isPseudo,
+        }, processManager, ringBuffer, logger);
+    }
+
+    public static getShellExecutablePath(): string {
+        const shell = process.env.THEIA_SHELL;
+        if (shell) {
+            return shell;
+        }
+        if (isWindows) {
+            return 'cmd.exe';
+        } else {
+            return process.env.SHELL!;
+        }
+    }
+
+    public static getShellExecutableArgs(): string[] {
+        const args = process.env.THEIA_SHELL_ARGS;
+        if (args) {
+            return parseArgs(args);
+        }
+        if (isOSX) {
+            return ['-l'];
+        } else {
+            return [];
+        }
+    }
+}

package/src/node/shell-terminal-server.spec.ts

@@ -1,40 +1,40 @@
-// *****************************************************************************
-// Copyright (C) 2017 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 * as chai from 'chai';
-import { createTerminalTestContainer } from './test/terminal-test-container';
-import { IShellTerminalServer } from '../common/shell-terminal-protocol';
-
-/**
- * Globals
- */
-
-const expect = chai.expect;
-
-describe('ShellServer', function (): void {
-
-    this.timeout(5000);
-    let shellTerminalServer: IShellTerminalServer;
-
-    beforeEach(() => {
-        shellTerminalServer = createTerminalTestContainer().get(IShellTerminalServer);
-    });
-
-    it('test shell terminal create', async function (): Promise<void> {
-        const createResult = shellTerminalServer.create({});
-
-        expect(await createResult).to.be.greaterThan(-1);
-    });
-});
+// *****************************************************************************
+// Copyright (C) 2017 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 * as chai from 'chai';
+import { createTerminalTestContainer } from './test/terminal-test-container';
+import { IShellTerminalServer } from '../common/shell-terminal-protocol';
+
+/**
+ * Globals
+ */
+
+const expect = chai.expect;
+
+describe('ShellServer', function (): void {
+
+    this.timeout(5000);
+    let shellTerminalServer: IShellTerminalServer;
+
+    beforeEach(() => {
+        shellTerminalServer = createTerminalTestContainer().get(IShellTerminalServer);
+    });
+
+    it('test shell terminal create', async function (): Promise<void> {
+        const createResult = shellTerminalServer.create({});
+
+        expect(await createResult).to.be.greaterThan(-1);
+    });
+});