Task Configuration

Examples

Create New Task Template

TODO : add a demo image showing a plugin float in task creation mode with the defaults

Example Task Configuration

TODO : add a demo image showing a plugin float in task creation mode with some values filled in

Options Documentation

Listed below is the full set of supported task configuration options with documentation on the corresponding behavior.

• name
  type: string, required - no defaults
  The name of this configured task that will be displayed on the task launch floating window.

• command
  type: string, required - no defaults
  Specifies the executable or the program that will be launched by this task.

• args
  type: string[], defaults to []
  List of command-line arguments fed to the executable or program specified by command.
  Each argument in this list will be concatenated together by a space character.

• cwd
  type: string, defaults to current working directory
  The path (absolute or relative) to the custom directory inside which this task will be executed.

• display
  type: 'float' | 'tabpage' | 'vsplit' | 'hsplit', defaults to 'float' or specified by setup()
  Controls how the task instance is rendered : floating window, tabpage, vertical split or horizontal split.
  This setting overrides the one specified at the plugin setup level.

• env
  type: { string: string | number }, defaults to {}
  Dictionary of environment variables to be defined in the task environment before execution.
  This dictionary extends / overrides the one specified at the plugin setup level.

• shell
  type: ShellOptions, defaults to {}
  Options to customize the shell that sets the context of the task environment.

  • ShellOptions.exe
    type: string, required - no defaults
    Absolute path to the custom shell executable (required if below args are specified).

  • ShellOptions.args
    type: string[], defaults to []
    List of command-line arguments fed to the custom shell executable.
    Each argument in this list will be concatenated together by a space character.