Module @theia/task

ECLIPSE THEIA - TASK EXTENSION

---

Description

The @theia/task extension extension permits executing scripts or binaries in the application's backend.

Tasks launch configurations can be defined independently for each workspace, under .theia/tasks.json. When present, they are automatically picked-up when a client opens a workspace, and watches for changes. A task can be executed by triggering the "Run Task" command (shortcut F1). A list of known tasks will then be available, one of which can be selected to trigger execution.

Each task configuration looks like this:

{
    "label": "Test task - list workspace files recursively",
    "type": "shell",
    "command": "ls",
    "args": [
        "-alR"
    ],
    "options": {
        "cwd": "${workspaceFolder}"
    },
    "windows": {
        "command": "cmd.exe",
        "args": [
            "/c",
            "dir",
            "/s"
        ]
    }
}
Copy

label: a unique string that identifies the task. That's what's shown to the user, when it's time to chose one task configuration to run.

type: determines what type of process will be used to execute the task. Can be "process" or "shell". "Shell" processes' output can be shown in Theia's frontend, in a terminal widget. If type set as "process" then task will be run without their output being shown.

command: the actual command or script to execute. The command can have no path (e.g. "ls") if it can be found in the system path. Else it can have an absolute path, in which case there is no confusion. Or it can have a relative path, in which case it will be interpreted to be relative to cwd. e.g. "./task" would be interpreted to mean a script or binary called "task", right under the workspace root directory.

args: a list of strings, each one being one argument to pass to the command.

options: the command options used when the command is executed. This is the place to provide the

• cwd: the current working directory, in which the task's command will execute. This is the equivalent of doing a "cd" to that directory, on the command-line, before running the command. This can contain the variable ${workspaceFolder}, which will be replaced at execution time by the path of the current workspace. If left undefined, will by default be set to workspace root.
• env: the environment of the executed program or shell. If omitted the parent process' environment is used.
• shell: configuration of the shell when task type is shell, where users can specify the shell to use with shell, and the arguments to be passed to the shell executable to run in command mode with args.

By default, command and args above are used on all platforms. However it's not always possible to express a task in the same way, both on Unix and Windows. The command and/or arguments may be different, for example. If a task needs to work on Linux, MacOS, and Windows, it is better to have separated command, command arguments, and options.

windows: if windows is defined, its command, command arguments, and options (i.e., windows.command, windows.args, and windows.options) will take precedence over the command, args, and options, when the task is executed on a Windows backend.

osx: if osx is defined, its command, command arguments, and options (i.e., osx.command, osx.args, and osx.options) will take precedence over the command, args, and options, when the task is executed on a MacOS backend.

linux: if linux is defined, its command, command arguments, and options (i.e., linux.command, linux.args, and linux.options) will take precedence over the command, args, and options, when the task is executed on a Linux backend.

Here is a sample tasks.json that can be used to test tasks. Just add this content under the theia source directory, in directory .theia:

{
    // Some sample Theia tasks
    "tasks": [
        {
            "label": "[Task] short running test task (~3s)",
            "type": "shell",
            "command": "./task",
            "args": [
                "default 1",
                "default 2",
                "default 3"
            ],
            "options": {
                "cwd": "${workspaceFolder}/packages/task/src/node/test-resources/"
            },
            "windows": {
                "command": "cmd.exe",
                "args": [
                    "/c",
                    "task.bat",
                    "windows abc"
                ]
            },
            "linux": {
                "args": [
                    "linux 1",
                    "linux 2",
                    "linux 3"
                ]
            }
        },
        {
            "label": "[Task] long running test task (~300s)",
            "type": "shell",
            "command": "./task-long-running",
            "args": [],
            "options": {
                "cwd": "${workspaceFolder}/packages/task/src/node/test-resources/"
            },
            "windows": {
                "command": "cmd.exe",
                "args": [
                    "/c",
                    "task-long-running.bat"
                ]
            }
        },
        {
            "label": "[Task] recursively list files from workspace root",
            "type": "shell",
            "command": "ls",
            "args": [
                "-alR"
            ],
            "options": {
                "cwd": "${workspaceFolder}"
            },
            "windows": {
                "command": "cmd.exe",
                "args": [
                    "/c",
                    "dir",
                    "/s"
                ]
            }
        },
        {
            "label": "[Task] Echo a string",
            "type": "shell",
            "command": "bash",
            "args": [
                "-c",
                "echo 1 2 3"
            ],
            "options": {
                "cwd": "${workspaceFolder}"
            }
        }
    ]
}
Copy

Variables substitution

The variables are supported in the following properties, using ${variableName} syntax:

• command
• args
• options.cwd
• windows.command
• windows.args
• windows.options.cwd
• osx.command
• osx.args
• osx.options.cwd
• linux.command
• linux.args
• linux.options.cwd

See here for a detailed documentation.

Contribution points

The extension provides contribution points:

• browser/TaskContribution - allows an extension to provide its own Task format and/or to provide the Tasks programmatically to the system

export interface TaskContribution {
    registerResolvers?(resolvers: TaskResolverRegistry): void;
    registerProviders?(providers: TaskProviderRegistry): void;
}
Copy

• node/TaskRunnerContribution - allows an extension to provide its own way of running/killing a Task

export interface TaskRunnerContribution {
    registerRunner(runners: TaskRunnerRegistry): void;
}
Copy

Additional Information

• API documentation for @theia/task
• Theia - GitHub
• Theia - Website

License

• Eclipse Public License 2.0
• 一 (Secondary) GNU General Public License, version 2 with the GNU Classpath Exception

Trademark

"Theia" is a trademark of the Eclipse Foundation https://www.eclipse.org/theia