Система плагинов

Около 1 мин...

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

Установка плагина

В начальную конфигурацию Waline добавлен атрибут plugins, который поддерживает настройку нескольких плагинов.

// index.js
const Waline = require('@waline/vercel');
const HelloWorldPlugin = require('@waline-plugins/hello-world');

module.exports = Waline({
  plugins: [HelloWorldPlugin],
});

Чтобы использовать чужой плагин напрямую, можно также поместить хуки плагина прямо в plugins:

// index.js
const Waline = require('@waline/vercel');
const HelloWorldPlugin = require('@waline-plugins/hello-world');

module.exports = Waline({
  plugins: [
    {
      hooks: {
        async postSave() {
          // do what ever you want after comment saved
        },
      },
      middlewares: [
        async (ctx, next) => {
          await next();
        },
      ],
    },
  ],
});

Создание плагина

Создание на основе хуков

Создать плагин несложно. Плагин представляет собой набор хуков.

module.exports = {
  hooks: {
    async postSave() {
      // do what ever you want after comment saved
    },
  },
};

Обратите внимание: если установлено несколько плагинов с хуками, одинаковые хуки выполняются в порядке установки плагинов. Если метод pre-hook досрочно возвращает значение, последующие операции не выполняются.

Создание на основе middleware

Если возможностей хуков не хватает, можно использовать более мощный режим middleware. В основе Waline лежит Node.js-фреймворк Koa, и мы полностью открываем конфигурацию middleware Koa, что позволяет опытным разработчикам реализовывать самые разные задачи.

Если вы не знаете, что такое middleware в Koa, сначала поищите информацию о них. При создании плагина в режиме middleware важно, чтобы в функции обратного вызова присутствовал вызов await next(), иначе последующие операции не выполнятся.

module.exports = {
  middlewares: [
    async (ctx, next) => {
      await next();
    },
  ],
};

Разумеется, логику плагинов на хуках и плагинов на middleware можно объединить — Waline это поддерживает.

Список плагинов

Будем рады вашим плагинам~

TIPS: Область комментариев предназначена только для демонстрации. Если у вас есть вопросы, пожалуйста, перейдите на Github Discussion чтобы задать их.