sistema de plugins

About 2 min...

Os usuários podem estender a função de hook personalizada através dos Hooks fornecidos pelo Waline para implementar funcionalidades personalizadas. Mas, se quiserem compartilhar métodos de Hook personalizados, eles só podem usar o método de copiar. Para resolver esse problema, o sistema de plugins do Waline surgiu.

Instalar o plugin

Um novo atributo plugins foi adicionado à configuração inicial do Waline, que suporta configurar vários plugins.

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

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

Para instalar diretamente o plugin de outras pessoas, você também pode colocar os hooks do plugin diretamente em 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();
        },
      ],
    },
  ],
});

Criar plugin

Criar com base em Hook

Criar um plugin é simples. Um plugin é composto por uma coleção de hooks.

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

Vale observar que, se o usuário instalar vários plugins de Hook, a execução da mesma função de hook ocorre na ordem em que os plugins foram instalados. Se o método de pré-hook retornar antecipadamente, nenhuma operação subsequente será executada.

Criar com base em middleware

Se o Hook não atender às suas necessidades, você pode usar o modo middleware, mais poderoso, para personalizar o desenvolvimento. A camada inferior do Waline usa o framework Node.js Koa, e expomos toda a configuração de middleware do Koa, o que pode atender às diversas necessidades de personalização de desenvolvedores avançados.

Se você não sabe o que é um middleware do Koa, pode pesquisar primeiro. O que você precisa observar ao usar o modo middleware para criar plugins é que o método de callback deve escrever a execução de await next(), caso contrário as operações seguintes não serão executadas.

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

Claro, você pode juntar a lógica de plugins do tipo Hook e de plugins do tipo middleware; o Waline suporta ambos.

Lista de plugins

Boas-vindas para enviar plugins~

TIPS: A área de comentários é apenas para demonstração. Se você tiver alguma dúvida, vá para Github Discussion para perguntar.