Cria um plugin no Discourse pode ser muito simples, depois de aprender algumas especificidades. O objetivo deste tópico é criar um esqueleto de plugin e apresentar os princípios básicos.
Seu ambiente de desenvolvimento
Certifique-se de que você tem um ambiente de desenvolvimento do Discourse sendo executado em seu computador. Recomendo que você use o guia de configuração adequado e volte aqui quando terminar.
plugin.rb
Use GitHub - discourse/discourse-plugin-skeleton: Template for Discourse plugins · GitHub para criar um esqueleto completo de plugin do Discourse no seu diretório de plugins
O esqueleto agora está incluído no núcleo do Discourse,
rake plugin:create[nome-do-plugin]criará um plugin usando o esqueleto
Quando o Discourse inicia, ele procura no diretório plugins subdiretórios que contenham um arquivo plugin.rb. O arquivo plugin.rb tem dois propósitos: é o manifesto do seu plugin com as informações obrigatórias sobre o plugin, incluindo: seu nome, informações de contato e uma descrição. O segundo propósito é inicializar qualquer código Ruby necessário para executar o seu plugin.
No nosso caso, não adicionaremos qualquer código Ruby, mas ainda precisamos do plugin.rb. Vamos criar o diretório basic-plugin com o arquivo plugin.rb dentro dele, com o seguinte conteúdo:
basic-plugin/plugin.rb
# name: basic-plugin
# about: Um plugin super simples para demonstrar como os plugins funcionam
# version: 0.0.1
# authors: Awesome Plugin Developer
# url: https://github.com/yourusername/basic-plugin
Depois de criar este arquivo, você deve reiniciar seu servidor local e o plugin deve ser carregado.
Uma pegadinha importante!
Se você está acostumado ao desenvolvimento regular em Rails, pode notar que os plugins não são tão bons em relação ao recarregamento. Em geral, quando você faz alterações no seu plugin, você deve Ctrl+c para parar o servidor, depois executá-lo novamente usando bin/dev.
Minhas alterações não foram aplicadas! 
Às vezes, o cache não é totalmente limpo, especialmente quando você cria novos arquivos ou exclui arquivos antigos. Para contornar esse problema, remova a pasta tmp e inicie o Rails novamente. Em um Mac, você pode fazer isso em um único comando: rm -rf tmp; bin/dev.
Verificando se o seu plugin foi carregado
Depois de reiniciar seu servidor local, acesse a URL /admin/plugins (certifique-se de estar logado em uma conta de administrador primeiro, pois apenas administradores podem ver o registro de plugins).
Se tudo funcionou, você deve ver seu plugin na lista:
Parabéns, você acabou de criar seu primeiro plugin!
Vamos adicionar algum JavaScript
Neste momento, seu plugin não faz nada. Vamos adicionar um arquivo JavaScript que abrirá uma caixa de alerta quando o Discourse carregar. Isso será extremamente irritante para qualquer usuário e não é recomendado como um plugin real, mas mostrará como inserir JavaScript em nossa aplicação em execução.
Crie o seguinte arquivo:
plugins/basic-plugin/assets/javascripts/discourse/initializers/alert.js
export default {
name: "alert",
initialize() {
alert("Caixas de alerta são irritantes!");
},
};
Agora, se você reiniciar seu servidor local, deverá ver “Caixas de alerta são irritantes!” aparecer na tela. (Se não viu, veja o cabeçalho “Minhas alterações não foram aplicadas” acima).
Vamos analisar como isso funcionou:
-
Arquivos JavaScript colocados em
assets/javascripts/discourse/initializerssão executados automaticamente quando a aplicação Discourse carrega. -
Este arquivo específico
exporta um objeto, que tem umnamee uma funçãoinitialize. -
O
namedeve ser único, então eu apenas o chamei dealert. -
A função
initialize()é chamada quando a aplicação carrega. No nosso caso, tudo o que ela faz é executar nosso códigoalert().
Pré-carregando dados para o frontend
Use register_preloaded_data em plugin.rb para incluir dados na resposta HTML inicial sem uma solicitação adicional:
after_initialize do
register_preloaded_data("visibility") do |guardian|
{ can_access: guardian.authenticated? }
end
end
O núcleo prefixa a chave com os metadados # name: do plugin. Para o basic-plugin acima, leia o valor analisado em um inicializador do frontend com:
import PreloadStore from "discourse/lib/preload-store";
const visibility = PreloadStore.get("basic-plugin:visibility");
O bloco é executado para cada carregamento de página que renderiza o layout da aplicação, recebe o Guardian da solicitação e retorna um valor serializável em JSON. Esses valores são separados do payload de site anônimo em cache. Retorne nil para omitir uma entrada; false é incluído. Blocos de plugins desativados são ignorados. Escopone dados sensíveis para o usuário solicitante através do Guardian.
Agora você é um desenvolvedor oficial de plugins do Discourse!
Mais na série
Parte 1: Este tópico
Parte 2: Saídas de Plugin
Parte 3: Configurações do Site
Parte 4: Configuração do Git
Parte 5: Interfaces de Administração
Parte 6: Testes de Aceitação
Parte 7: Publique seu plugin
Este documento tem controle de versão - sugira alterações no GitHub.

