PHP Storm вместо консоли для MODX

Брюзжание о заметке-ссылке

Сразу извинюсь за то, что вместо полноценной заметки это скорее заметка-ссылка, но на то есть несколько причин. Первая и главная — это дурацкий редактор заметок на сайте, который отбивает всякое желание писать эти самые заметки. Возможно я брюзжу, но последние годы я привык писать тексты в markdown, где все крайне логично как на этапе написания текста, так и после, когда он уже преобразован в html. Здесь же стоит типограф Jevix, который бесит и заставляет заметку редактировать по 10 минут, пока она не станет нормально выглядеть.

Ну и другая причина кроется в том, что у меня есть свой сайт, где мне хотелось бы публиковать свои заметки и мне конечно же хочется, чтобы их читали именно там. Но дело в том, что на modx.pro нет возможности указать cannonical на оригинальный текст, чтобы поисковые системы правильно понимали, где оригинальное содержимое.

Звучит, будто жалуюсь, но этим хочу подтолкнуть сообщество и ребят, которые стоят за сайтом, обратить внимание на проблему и решить ее. Теперь же давайте к сути. Здесь в заметке будет вступление, а по ссылке уже все подробности. Не обессудьте.

О проблемах запуска скриптов

Итак, заметка о том, как настроить PHP Storm, чтобы не выходя из IDE, писать и запускать скрипты, которые работают с MODX прямо на удаленном сервере. По сути, как заменить дополнение Console нормальным инструментом для работы с кодом, где есть автоматические дополнения, инспекции и вообще вся мощь IDE.

Понадобилось мне тут недавно написать один скрипт для импорта данных из API в MODX. Сам скрипт можно написать и локально, это обычно трудностей не вызывает, но сайт уже рабочий и мне нужно было иметь доступ к объектам MODX, чтобы их обновлять или создавать, в зависимости от ситуации.

В целом, решений для запуска кода в MODX хватает. Можно написать снипет и вызывать его где-то на странице. Можно установить дополнение Console или modalConsole, и запускать свой скрипт там. Так будет даже правильнее, чем через снипет. Но это всё работает через web-server, т.е. подходит для небольших скриптов, которые выполняются за отведённые стандартные 30 секунд. Для полноценного CLI-приложения не годится. Особенно, если мы говорим об импорте, который может работать и десятки минут, если задачи тяжелые. Для тяжелых задач правильнее использовать очереди, конечно же, но у нас MODX и несмотря на то, что очереди в MODX есть, работать с ними умеет не каждый.

Другая проблема заключается в том, что несмотря на существование Ace, в браузерных редакторах никогда не будет той мощи, которую дает полноценная IDE. Это проверки качества кода и умные инспекции, автоматическое дополнение и другие удобства. Я обычно пишу код в PHP Storm, поэтому решил, что потратить немного времени и настроить один раз IDE (и рассказать об этом в заметке) будет эффективнее, чем страдать с другими инструментами.

Рассказывать я буду на примере сайта, размещенного на хостинге modhost.pro, но подход можно применять на любом хостинге, где есть доступ по SSH. Файлы скопировать хватит и FTP, но чтобы запускать CLI-приложение, без SSH не обойтись. Так же я работаю на macOS, поэтому на других операционных системах некоторые комбинации клавиш или настройки путей могут быть иными, но я думаю, разберётесь.

В целом, схема получается следующая. Мы пишем код в IDE, он должен каким-то образом попасть на сервер, а после этого нам нужно этот код запустить из той же IDE. Одного инструмента для реализации такого порядка нет, но связка из нескольких позволяет так сделать. Итого, у нас имеется две проблемы, которые необходимо решить: автоматически доставить код на сервер после изменений и выполнить его на удаленном сервере. Начнем с автоматической доставки.

Продолжение тут → klimchuk.by/notes/php-storm-console-for-modx/

P.S. Вступление я писал давно, но относительно недавно, откликнувшись на клич @Иван Бочкарев помочь с обновлением сайта сообщества, т.е. этого — modx.pro, я одну из проблем, озвученных в заметке, уже решил. Pell request с добавлением поля для указания canonical не покажу, так как репозиторий приватный, тем не менее код ожидает проверки и надеюсь, в скором времени будет загружен на сайт. Глядишь, дойдут руки и вторую решить, тогда совсем хорошо заживем.