WebStorm 2018.2 Help

Create/Edit/Copy Tool Dialog

From the External Tools page: icons general add, icons actions edit svg or icons actions copy svg


Edit the settings for your external tool.

ItemDescription
Name The name of the tool that appears as a command name in the Tools menu and the context menus.
Group The group the tool belongs to. The tool groups correspond to submenus in the Tools menu and the context menus.

Select an existing group from the list.

To create a new group, simply type its name in the list.

Description The tool description (optional).
Tool Settings
Program The path to the executable file to be run. Use browseButton to select the file, Insert macro to open the Macros dialog to select a macro.

(Macros are resolved at runtime and let you specify context information such as currently selected file, your project source paths, etc.)

Arguments The arguments to be passed to the program the way you'd specify them on the command line. Use Insert macro to open the Macros dialog to select a macro.

When specifying the arguments, follow these rules:

  • Note that external tools provide the absolute path of the files, not project-directory-relative ones.
  • Use spaces to separate individual arguments.
  • If an argument includes spaces, enclose the spaces or the argument that contains the spaces in double quotes, for example, some" "arg or "some arg".
  • If an argument includes double quotes (e.g. as part of the argument), escape the double quotes by means of the backslashes, for example, -Dmy.prop=\"quoted_value\".
Working directory The path to the current working directory for the program. Use browseButton to select the directory, Insert macro to open the Macros dialog to select a macro.
Advanced Options
Synchronize files after execution Make WebStorm aware of changes in the file system when the tool completes its execution.
Open console for tool output Open the console for viewing the tool output such error messages, etc.
Make console active on message in stdout Make the output console active and bring it forward when the corresponding event occurs.
Make console active on message in stderr The same as the previous option but for stderr.
Output Filters The output filters are used to turn absolute file paths and line numbers in the tool output into hyperlinks. You'll be able to use those links to open the corresponding files in the editor. You can specify one or several filters. Each line is a regular expression. You can use the following macros: $FILE_PATH$, $LINE$ and $COLUMN$, for example,
$FILE_PATH$:$LINE$:$COLUMN$:.*
Last modified: 14 September 2018

See Also