Запуск внешних инструментов в PhpStorm

Последнее обновление: 07.04.2017 г.
Публикация: 07.04.2017 г.
Информация

В этом руководстве описывается настройка и запуск внешних инструментов в PhpStorm. Все действия, описанные здесь, были воспроизведены с корректными ожидаемыми результатами на PhpStorm 2016.1.2.

Хотя PhpStorm и поставляется с большим количеством интегрированных утилит и инструментов, невозможно включить каждый инструмент в IDE. Настроив External Tools (внешние инструменты), ты можешь создать ярлык для запуска инструмента и вызывать его из главного меню IDE или с помощью горячих клавиш.

Например, многие графические редакторы создают изображения в формате PNG, которые не оптимизированы. Для решения этого вопроса ты можешь использовать программу OptiPNG, как внешний инструмент. Это позволит тебе легко и просто оптимизировать необходимые изображения.

PhpStorm: запуск OptiPNG через главное меню

Давай посмотрим, как это настроить.

1. Создание внешнего инструмента

С помощью главного меню IDE [File → Settings... → Tools → External Tools] ты можешь перейти в раздел External Tools и использовать его панель инструментов для добавления, редактирования или удаления внешнего инструмента.

При создании нового внешнего инструмента нужно указать несколько основных опций:

  • Name — имя для инструмента, которое также будет показано в меню.
  • Description — описание для инструмента, которое будет показано в строке состояния PhpStorm.
  • Group — группа для инструмента, которая используется для разделения внешних инструментов по типам в подменю. Группы удобно использовать, если внешних инструментов множество.

Если ты хочешь видеть вывод работы внешнего инструмента в Console (консоль), то не выключай опцию Open console (открыть консоль), по умолчанию она включена. По желанию, конечно, ты можешь отключить её. Тогда отображение вывода внешнего инструмента будет происходить только в случае появления ошибки.

Также существует возможность указать, в каких частях IDE необходимо отображать внешний инструмент. Это можно сделать с помощью опций секции Show in (показывать в):

  • Main menu — главное меню в IDE.
  • Editor menu — контекстное меню в окне редактирования кода.
  • Project views — контекстное меню в окне проекта.
  • Search results — результаты поиска.

На скриншоте ниже используются настройки по умолчанию.

PhpStorm: окно «Edit Tool»

В окне Edit Tool самая важная секция Tool settings (настройки инструмента):

  • Program — путь к программе для запуска.
  • Parameters — аргументы программы.
  • Working directory — рабочий каталог программы.

В примере выше, программа OptiPNG будет запущена с параметрами -o4 $FilePath$. Обрати внимание, ты можешь использовать макросы в этих параметрах, которые могут быть использованы для обозначения: имени проекта, текущего пути к файлу, пути к PHP интерпретатору и так далее. С помощью кнопки Insert macro… ты можешь получить список всех доступных макросов и их значений.

2. Создание горячих клавиш для внешнего инструмента*

Использовать сочетания клавиш для запуска внешних инструментов очень удобно. Назначение горячих клавиш в PhpStorm происходит в разделе Keymap (раскладка), попасть в который можно с помощью главного меню IDE: [File → Settings... → Keymap]. Затем нужно открыть каталог External Tools и найти необходимый инструмент, который ты создал ранее. После чего используй пункт контекстного меню Add Keyboard Shortcut для назначения нужного сочетания клавиш. В примере ниже установлено сочетание клавиш Alt + I:

PhpStorm: окно «Keyboard Shortcut»

3. Работа с внешним инструментом

После создания внешнего инструмента, ты сразу можешь запускать его одним из указанных тобою способов. Например, с помощью главного меню Tools или контекстного меню в окне проекта:

PhpStorm: запуск OptiPNG через контекстное меню

Также ты можешь вызывать инструмент с помощью сочетания клавиш, в данном случае Alt + I будет запускать внешний инструмент OptiPNG. Если ты не менял настройки по умолчанию при создании инструмента, то откроется окно Console, где будет показан вывод работы OptiPNG.

PhpStorm: вывод работы OptiPNG

Пункт является опциональным при изучении руководства: Запуск внешних инструментов в PhpStorm.

Контрольные вопросы
Источники и дополнительные материалы