Создание плагина в Discourse может быть очень простым, как только вы освоите некоторые нюансы. Цель этого поста — создать скелет плагина и познакомить вас с основами.
Ваша среда разработки
Убедитесь, что у вас на компьютере запущена среда разработки Discourse. Рекомендую воспользоваться соответствующим руководством по установке и вернуться сюда, когда закончите.
plugin.rb
Используйте GitHub - discourse/discourse-plugin-skeleton: Template for Discourse plugins · GitHub для создания полного скелета плагина Discourse в вашей директории plugins
Теперь скелет включен в ядро Discourse. Команда
rake plugin:create[plugin-name]создаст плагин на основе этого скелета.
При запуске Discourse ищет в директории plugins подкаталоги, содержащие файл plugin.rb. У файла plugin.rb две цели: он служит манифестом вашего плагина, содержащим обязательную информацию о нем, включая название, контактные данные и описание. Вторая цель — инициализация любого кода на Ruby, необходимого для работы вашего плагина.
В нашем случае мы не будем добавлять код на Ruby, но файл plugin.rb нам все равно нужен. Создадим директорию basic-plugin с файлом plugin.rb внутри, со следующим содержимым:
basic-plugin/plugin.rb
# name: basic-plugin
# about: A super simple plugin to demonstrate how plugins work
# version: 0.0.1
# authors: Awesome Plugin Developer
# url: https://github.com/yourusername/basic-plugin
Как только вы создадите этот файл, вам следует перезапустить локальный сервер, и плагин должен быть загружен.
Важный подвох!
Если вы привыкли к обычной разработке на Rails, вы можете заметить, что с плагины не так удобны в отношении перезагрузки. В общем случае, при внесении изменений в ваш плагин, следует нажать Ctrl+c, чтобы остановить сервер, а затем запустить его снова с помощью bin/dev.
Мои изменения не применились! 
Иногда кэш не очищается полностью, особенно при создании новых файлов или удалении старых. Чтобы обойти эту проблему, удалите папку tmp и снова запустите Rails. На Mac это можно сделать одной командой: rm -rf tmp; bin/dev.
Проверка того, что ваш плагин загружен
После перезапуска локального сервера перейдите по адресу /admin/plugins (убедитесь, что вы вошли под учетной записью администратора, так как только администраторы могут видеть реестр плагинов).
Если все прошло успешно, вы увидите свой плагин в списке:
Поздравляем, вы только что создали свой первый плагин!
Добавим немного JavaScript
На данный момент ваш плагин ничего не делает. Давайте добавим JavaScript-файл, который будет показывать всплывающее окно предупреждения при загрузке Discourse. Это будет очень раздражать любого пользователя, и мы не рекомендуем использовать это в качестве реального плагина, но это покажет, как внедрять JavaScript в наше работающее приложение.
Создайте следующий файл:
plugins/basic-plugin/assets/javascripts/discourse/initializers/alert.js
export default {
name: "alert",
initialize() {
alert("alert boxes are annoying!");
},
};
Теперь, если вы перезапустите локальный сервер, на экране должно появиться сообщение “alert boxes are annoying!”. (Если этого не произошло, см. заголовок “Мои изменения не применились” выше).
Давайте разберем, как это работает:
-
JavaScript-файлы, помещенные в
assets/javascripts/discourse/initializers, выполняются автоматически при загрузке приложения Discourse. -
Этот конкретный файл
exports один объект, который имеетnameи функциюinitialize. -
nameдолжен быть уникальным, поэтому я просто назвал егоalert. -
Функция
initialize()вызывается при загрузке приложения. В нашем случае она просто выполняет наш кодalert().
Предварительная загрузка данных для фронтенда
Используйте register_preloaded_data в plugin.rb, чтобы включить данные в начальный HTML-ответ без дополнительных запросов:
after_initialize do
register_preloaded_data("visibility") do |guardian|
{ can_access: guardian.authenticated? }
end
end
Ядро добавляет префикс к ключу с использованием метаданных # name: плагина. Для вышеупомянутого basic-plugin получите разобранный значение в инициализаторе фронтенда с помощью:
import PreloadStore from "discourse/lib/preload-store";
const visibility = PreloadStore.get("basic-plugin:visibility");
Блок выполняется для каждой загрузки страницы, которая отображает макет приложения, получает Guardian запроса и возвращает значение, сериализуемое в JSON. Эти значения отделены от кэшированной анонимной нагрузки сайта. Возврат nil пропускает запись; false включается. Блоки отключенных плагинов пропускаются. Ограничивайте чувствительные данные пользователем, отправляющим запрос, через Guardian.
Теперь вы официальный разработчик плагинов Discourse!
Продолжение серии
Часть 1: Эта тема
Часть 2: Слоты плагинов
Часть 3: Настройки сайта
Часть 4: Настройка git
Часть 5: Интерфейсы администратора
Часть 6: Приемочные тесты
Часть 7: Публикация вашего плагина
Этот документ находится под контролем версий — предложите изменения на github.

