@theia/task 1.45.1 → 1.46.0-next.72

package/src/common/problem-matcher-protocol.ts

@@ -1,234 +1,234 @@
-// *****************************************************************************
-// 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
-// *****************************************************************************
-
-// This file is inspired by VSCode https://github.com/Microsoft/vscode/blob/1.33.1/src/vs/workbench/contrib/tasks/common/problemMatcher.ts
-// 'problemMatcher.ts' copyright:
-/*---------------------------------------------------------------------------------------------
- *  Copyright (c) Microsoft Corporation. All rights reserved.
- *  Licensed under the MIT License. See License.txt in the project root for license information.
- *--------------------------------------------------------------------------------------------*/
-
-import { URI } from '@theia/core';
-import { Severity } from '@theia/core/lib/common/severity';
-import { Diagnostic } from '@theia/core/shared/vscode-languageserver-protocol';
-
-export enum ApplyToKind {
-    allDocuments,
-    openDocuments,
-    closedDocuments
-}
-
-export namespace ApplyToKind {
-    export function fromString(value: string | undefined): ApplyToKind | undefined {
-        if (value) {
-            value = value.toLowerCase();
-            if (value === 'alldocuments') {
-                return ApplyToKind.allDocuments;
-            } else if (value === 'opendocuments') {
-                return ApplyToKind.openDocuments;
-            } else if (value === 'closeddocuments') {
-                return ApplyToKind.closedDocuments;
-            }
-        }
-        return undefined;
-    }
-}
-
-export enum FileLocationKind {
-    Auto,
-    Relative,
-    Absolute
-}
-
-export namespace FileLocationKind {
-    export function fromString(value: string): FileLocationKind | undefined {
-        value = value.toLowerCase();
-        if (value === 'absolute') {
-            return FileLocationKind.Absolute;
-        } else if (value === 'relative') {
-            return FileLocationKind.Relative;
-        } else {
-            return undefined;
-        }
-    }
-}
-
-export interface WatchingPattern {
-    regexp: string;
-    file?: number;
-}
-
-export interface WatchingMatcher {
-    // If set to true the background monitor is in active mode when the task starts.
-    // This is equals of issuing a line that matches the beginPattern
-    activeOnStart: boolean;
-    beginsPattern: WatchingPattern;
-    endsPattern: WatchingPattern;
-}
-export namespace WatchingMatcher {
-    export function fromWatchingMatcherContribution(value: WatchingMatcherContribution | undefined): WatchingMatcher | undefined {
-        if (!value) {
-            return undefined;
-        }
-        return {
-            activeOnStart: !!value.activeOnStart,
-            beginsPattern: typeof value.beginsPattern === 'string' ? { regexp: value.beginsPattern } : value.beginsPattern,
-            endsPattern: typeof value.endsPattern === 'string' ? { regexp: value.endsPattern } : value.endsPattern
-        };
-    }
-}
-
-export enum ProblemLocationKind {
-    File,
-    Location
-}
-
-export namespace ProblemLocationKind {
-    export function fromString(value: string): ProblemLocationKind | undefined {
-        value = value.toLowerCase();
-        if (value === 'file') {
-            return ProblemLocationKind.File;
-        } else if (value === 'location') {
-            return ProblemLocationKind.Location;
-        } else {
-            return undefined;
-        }
-    }
-}
-
-export interface ProblemMatcher {
-    deprecated?: boolean;
-
-    owner: string;
-    source?: string;
-    applyTo: ApplyToKind;
-    fileLocation: FileLocationKind;
-    filePrefix?: string;
-    pattern: ProblemPattern | ProblemPattern[];
-    severity?: Severity;
-    watching?: WatchingMatcher;
-    uriProvider?: (path: string) => URI;
-}
-
-export interface NamedProblemMatcher extends ProblemMatcher {
-    name: string;
-    label: string;
-}
-
-export namespace ProblemMatcher {
-    export function isWatchModeWatcher(matcher: ProblemMatcher): boolean {
-        return !!matcher.watching;
-    }
-}
-
-export interface ProblemPattern {
-    name?: string;
-
-    regexp: string;
-
-    kind?: ProblemLocationKind;
-    file?: number;
-    message?: number;
-    location?: number;
-    line?: number;
-    character?: number;
-    endLine?: number;
-    endCharacter?: number;
-    code?: number;
-    severity?: number;
-    loop?: boolean;
-}
-
-export interface NamedProblemPattern extends ProblemPattern {
-    name: string;
-}
-
-export namespace ProblemPattern {
-    export function fromProblemPatternContribution(value: ProblemPatternContribution): ProblemPattern {
-        return {
-            name: value.name,
-            regexp: value.regexp,
-            kind: value.kind ? ProblemLocationKind.fromString(value.kind) : undefined,
-            file: value.file,
-            message: value.message,
-            location: value.location,
-            line: value.line,
-            character: value.column || value.character,
-            endLine: value.endLine,
-            endCharacter: value.endColumn || value.endCharacter,
-            code: value.code,
-            severity: value.severity,
-            loop: value.loop
-        };
-    }
-}
-
-export interface ProblemMatch {
-    resource?: URI;
-    description: ProblemMatcher;
-}
-
-export interface ProblemMatchData extends ProblemMatch {
-    marker: Diagnostic;
-}
-export namespace ProblemMatchData {
-    export function is(data: ProblemMatch): data is ProblemMatchData {
-        return 'marker' in data;
-    }
-}
-
-export interface WatchingMatcherContribution {
-    // If set to true the background monitor is in active mode when the task starts.
-    // This is equals of issuing a line that matches the beginPattern
-    activeOnStart?: boolean;
-    beginsPattern: string | WatchingPattern;
-    endsPattern: string | WatchingPattern;
-}
-
-export interface ProblemMatcherContribution {
-    base?: string;
-    name?: string;
-    label: string;
-    deprecated?: boolean;
-
-    owner: string;
-    source?: string;
-    applyTo?: string;
-    fileLocation?: 'absolute' | 'relative' | string[];
-    pattern: string | ProblemPatternContribution | ProblemPatternContribution[];
-    severity?: string;
-    watching?: WatchingMatcherContribution; // deprecated. Use `background`.
-    background?: WatchingMatcherContribution;
-}
-
-export interface ProblemPatternContribution {
-    name?: string;
-    regexp: string;
-
-    kind?: string;
-    file?: number;
-    message?: number;
-    location?: number;
-    line?: number;
-    character?: number;
-    column?: number;
-    endLine?: number;
-    endCharacter?: number;
-    endColumn?: number;
-    code?: number;
-    severity?: number;
-    loop?: boolean;
-}
+// *****************************************************************************
+// 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
+// *****************************************************************************
+
+// This file is inspired by VSCode https://github.com/Microsoft/vscode/blob/1.33.1/src/vs/workbench/contrib/tasks/common/problemMatcher.ts
+// 'problemMatcher.ts' copyright:
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { URI } from '@theia/core';
+import { Severity } from '@theia/core/lib/common/severity';
+import { Diagnostic } from '@theia/core/shared/vscode-languageserver-protocol';
+
+export enum ApplyToKind {
+    allDocuments,
+    openDocuments,
+    closedDocuments
+}
+
+export namespace ApplyToKind {
+    export function fromString(value: string | undefined): ApplyToKind | undefined {
+        if (value) {
+            value = value.toLowerCase();
+            if (value === 'alldocuments') {
+                return ApplyToKind.allDocuments;
+            } else if (value === 'opendocuments') {
+                return ApplyToKind.openDocuments;
+            } else if (value === 'closeddocuments') {
+                return ApplyToKind.closedDocuments;
+            }
+        }
+        return undefined;
+    }
+}
+
+export enum FileLocationKind {
+    Auto,
+    Relative,
+    Absolute
+}
+
+export namespace FileLocationKind {
+    export function fromString(value: string): FileLocationKind | undefined {
+        value = value.toLowerCase();
+        if (value === 'absolute') {
+            return FileLocationKind.Absolute;
+        } else if (value === 'relative') {
+            return FileLocationKind.Relative;
+        } else {
+            return undefined;
+        }
+    }
+}
+
+export interface WatchingPattern {
+    regexp: string;
+    file?: number;
+}
+
+export interface WatchingMatcher {
+    // If set to true the background monitor is in active mode when the task starts.
+    // This is equals of issuing a line that matches the beginPattern
+    activeOnStart: boolean;
+    beginsPattern: WatchingPattern;
+    endsPattern: WatchingPattern;
+}
+export namespace WatchingMatcher {
+    export function fromWatchingMatcherContribution(value: WatchingMatcherContribution | undefined): WatchingMatcher | undefined {
+        if (!value) {
+            return undefined;
+        }
+        return {
+            activeOnStart: !!value.activeOnStart,
+            beginsPattern: typeof value.beginsPattern === 'string' ? { regexp: value.beginsPattern } : value.beginsPattern,
+            endsPattern: typeof value.endsPattern === 'string' ? { regexp: value.endsPattern } : value.endsPattern
+        };
+    }
+}
+
+export enum ProblemLocationKind {
+    File,
+    Location
+}
+
+export namespace ProblemLocationKind {
+    export function fromString(value: string): ProblemLocationKind | undefined {
+        value = value.toLowerCase();
+        if (value === 'file') {
+            return ProblemLocationKind.File;
+        } else if (value === 'location') {
+            return ProblemLocationKind.Location;
+        } else {
+            return undefined;
+        }
+    }
+}
+
+export interface ProblemMatcher {
+    deprecated?: boolean;
+
+    owner: string;
+    source?: string;
+    applyTo: ApplyToKind;
+    fileLocation: FileLocationKind;
+    filePrefix?: string;
+    pattern: ProblemPattern | ProblemPattern[];
+    severity?: Severity;
+    watching?: WatchingMatcher;
+    uriProvider?: (path: string) => URI;
+}
+
+export interface NamedProblemMatcher extends ProblemMatcher {
+    name: string;
+    label: string;
+}
+
+export namespace ProblemMatcher {
+    export function isWatchModeWatcher(matcher: ProblemMatcher): boolean {
+        return !!matcher.watching;
+    }
+}
+
+export interface ProblemPattern {
+    name?: string;
+
+    regexp: string;
+
+    kind?: ProblemLocationKind;
+    file?: number;
+    message?: number;
+    location?: number;
+    line?: number;
+    character?: number;
+    endLine?: number;
+    endCharacter?: number;
+    code?: number;
+    severity?: number;
+    loop?: boolean;
+}
+
+export interface NamedProblemPattern extends ProblemPattern {
+    name: string;
+}
+
+export namespace ProblemPattern {
+    export function fromProblemPatternContribution(value: ProblemPatternContribution): ProblemPattern {
+        return {
+            name: value.name,
+            regexp: value.regexp,
+            kind: value.kind ? ProblemLocationKind.fromString(value.kind) : undefined,
+            file: value.file,
+            message: value.message,
+            location: value.location,
+            line: value.line,
+            character: value.column || value.character,
+            endLine: value.endLine,
+            endCharacter: value.endColumn || value.endCharacter,
+            code: value.code,
+            severity: value.severity,
+            loop: value.loop
+        };
+    }
+}
+
+export interface ProblemMatch {
+    resource?: URI;
+    description: ProblemMatcher;
+}
+
+export interface ProblemMatchData extends ProblemMatch {
+    marker: Diagnostic;
+}
+export namespace ProblemMatchData {
+    export function is(data: ProblemMatch): data is ProblemMatchData {
+        return 'marker' in data;
+    }
+}
+
+export interface WatchingMatcherContribution {
+    // If set to true the background monitor is in active mode when the task starts.
+    // This is equals of issuing a line that matches the beginPattern
+    activeOnStart?: boolean;
+    beginsPattern: string | WatchingPattern;
+    endsPattern: string | WatchingPattern;
+}
+
+export interface ProblemMatcherContribution {
+    base?: string;
+    name?: string;
+    label: string;
+    deprecated?: boolean;
+
+    owner: string;
+    source?: string;
+    applyTo?: string;
+    fileLocation?: 'absolute' | 'relative' | string[];
+    pattern: string | ProblemPatternContribution | ProblemPatternContribution[];
+    severity?: string;
+    watching?: WatchingMatcherContribution; // deprecated. Use `background`.
+    background?: WatchingMatcherContribution;
+}
+
+export interface ProblemPatternContribution {
+    name?: string;
+    regexp: string;
+
+    kind?: string;
+    file?: number;
+    message?: number;
+    location?: number;
+    line?: number;
+    character?: number;
+    column?: number;
+    endLine?: number;
+    endCharacter?: number;
+    endColumn?: number;
+    code?: number;
+    severity?: number;
+    loop?: boolean;
+}

package/src/common/process/task-protocol.ts

@@ -1,97 +1,97 @@
-// *****************************************************************************
-// Copyright (C) 2018 Red Hat, Inc. 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 { TaskConfiguration, TaskInfo } from '../task-protocol';
-import { ApplicationError } from '@theia/core/lib/common/application-error';
-
-export type ProcessType = 'shell' | 'process';
-
-export interface CommandOptions {
-    /**
-     * The 'current working directory' the task will run in. Can be a uri-as-string
-     * or plain string path. If the cwd is meant to be somewhere under the workspace,
-     * one can use the variable `${workspaceFolder}`, which will be replaced by its path,
-     * at runtime. If not specified, defaults to the workspace root.
-     * ex:  cwd: '${workspaceFolder}/foo'
-     */
-    cwd?: string;
-
-    /**
-     * The environment of the executed program or shell. If omitted the parent process' environment is used.
-     */
-    env?: { [key: string]: string | undefined; };
-
-    /**
-     * Configuration of the shell when task type is `shell`
-     */
-    shell?: {
-        /**
-         * The shell to use.
-         */
-        executable: string;
-
-        /**
-         * The arguments to be passed to the shell executable to run in command mode
-         * (e.g ['-c'] for bash or ['/S', '/C'] for cmd.exe).
-         */
-        args?: string[];
-    };
-}
-
-export interface CommandProperties {
-    readonly command?: string;
-    readonly args?: string[];
-    readonly options?: CommandOptions;
-}
-
-/** Configuration of a Task that may be run as a process or a command inside a shell. */
-export interface ProcessTaskConfiguration extends TaskConfiguration, CommandProperties {
-    readonly type: ProcessType;
-
-    /**
-     * Windows specific task configuration
-     */
-    readonly windows?: CommandProperties;
-
-    /**
-     * macOS specific task configuration
-     */
-    readonly osx?: CommandProperties;
-
-    /**
-     * Linux specific task configuration
-     */
-    readonly linux?: CommandProperties;
-}
-
-export interface ProcessTaskInfo extends TaskInfo {
-    /** process id. Defined if task is run as a process */
-    readonly processId?: number;
-    /** process task command */
-    readonly command?: string;
-}
-export namespace ProcessTaskInfo {
-    export function is(info: TaskInfo): info is ProcessTaskInfo {
-        return info['processId'] !== undefined;
-    }
-}
-
-export namespace ProcessTaskError {
-    export const CouldNotRun = ApplicationError.declare(1, (code: string) => ({
-        message: `Error starting process (${code})`,
-        data: { code }
-    }));
-}
+// *****************************************************************************
+// Copyright (C) 2018 Red Hat, Inc. 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 { TaskConfiguration, TaskInfo } from '../task-protocol';
+import { ApplicationError } from '@theia/core/lib/common/application-error';
+
+export type ProcessType = 'shell' | 'process';
+
+export interface CommandOptions {
+    /**
+     * The 'current working directory' the task will run in. Can be a uri-as-string
+     * or plain string path. If the cwd is meant to be somewhere under the workspace,
+     * one can use the variable `${workspaceFolder}`, which will be replaced by its path,
+     * at runtime. If not specified, defaults to the workspace root.
+     * ex:  cwd: '${workspaceFolder}/foo'
+     */
+    cwd?: string;
+
+    /**
+     * The environment of the executed program or shell. If omitted the parent process' environment is used.
+     */
+    env?: { [key: string]: string | undefined; };
+
+    /**
+     * Configuration of the shell when task type is `shell`
+     */
+    shell?: {
+        /**
+         * The shell to use.
+         */
+        executable: string;
+
+        /**
+         * The arguments to be passed to the shell executable to run in command mode
+         * (e.g ['-c'] for bash or ['/S', '/C'] for cmd.exe).
+         */
+        args?: string[];
+    };
+}
+
+export interface CommandProperties {
+    readonly command?: string;
+    readonly args?: string[];
+    readonly options?: CommandOptions;
+}
+
+/** Configuration of a Task that may be run as a process or a command inside a shell. */
+export interface ProcessTaskConfiguration extends TaskConfiguration, CommandProperties {
+    readonly type: ProcessType;
+
+    /**
+     * Windows specific task configuration
+     */
+    readonly windows?: CommandProperties;
+
+    /**
+     * macOS specific task configuration
+     */
+    readonly osx?: CommandProperties;
+
+    /**
+     * Linux specific task configuration
+     */
+    readonly linux?: CommandProperties;
+}
+
+export interface ProcessTaskInfo extends TaskInfo {
+    /** process id. Defined if task is run as a process */
+    readonly processId?: number;
+    /** process task command */
+    readonly command?: string;
+}
+export namespace ProcessTaskInfo {
+    export function is(info: TaskInfo): info is ProcessTaskInfo {
+        return info['processId'] !== undefined;
+    }
+}
+
+export namespace ProcessTaskError {
+    export const CouldNotRun = ApplicationError.declare(1, (code: string) => ({
+        message: `Error starting process (${code})`,
+        data: { code }
+    }));
+}