Pular para o conteúdo principal
Version: v4.5.0

Criar um Plugin

Antes de você começar​

Um Plugin permite a agregação de novas capacidades ao Template base por meio de ações como:

  • Inclusão de código fonte;
  • Importação de bibliotecas;
  • Execução de comandos e operações complexas para adicionar essas capacidades.

A estrutura de um Plugin também é a mesma de um Template, se diferenciando apenas pelo tipo que é app, em vez de app-template. Todos os passos do Template podem ser aplicados ao Plugin, diferenciando apenas alguns comandos.

caution

Para adicionar um Plugin em um Template é preciso, obrigatoriamente, criar uma Stack. Você pode entender o conceito de Stack no Glossário e aprender a Criar uma Stack

Criar Plugin​

Você pode criar um Plugin de duas formas:
1. Criar diretamente em uma Stack.
2. Criar o Plugin já atrelado a algum repositório.

Este guia mostra a segunda opção. Para detalhes da primeira forma consulte a página Criar uma Stack.

Criar Plugin para ser compartilhado​

Siga os passos abaixo para criar um Plugin:

Passo 1. Criar seu repositório Git​

Crie um repositório Git para hospedar o seu Plugin.

Passo 2. Criar o Plugin localmente​

Rode o comando abaixo para criar o seu Plugin. É obrigatório nomeá-lo:

stk-legacy create plugin <nome-do-plugin>

Logo depois, descreva o que esse Plugin faz.

Passo 3. Hospedar o Plugin no seu repositório​

Agora, você precisa subir esse Plugin de forma isolada no repositório que você criou no Passo 1.

  • Entre na pasta do Plugin, no exemplo desse guia, o nome é 'nome-do-plugin': 
cd <nome-do-plugin>
git remote add origin <url_do_seu_repo>
git push origin main

Passo 4. Adicionar esse Plugin na Stack​

Adicione o seu Plugin na Stack que você quiser.

  1. Entre na pasta da Stack:
cd <nome-da-stack>
  1. Use a URL do seu repositório e execute o comando:
stk-legacy add plugin <url-do-seu-repo-de-plugin>

Pronto, o Plugin foi adicionado na Stack!

Passo 5. Hospedar a Stack no repositório​

Execute o comando abaixo para subir a sua Stack no repositório:

git push origin main

Passo 6. Importar a Stack​

Este passo é necessário se você já criou e subiu no repositório uma Stack recentemente.

Para importá-la, execute o comando abaixo no terminal:

stk-legacy import stack <URL-Git-da-stack>

Passo 7. Atualizar a sua Stack​

Este passo é necessário se você já tem uma Stack importada.

Para atualizá-la, execute o comando abaixo:

stk-legacy update stack <nome-da-stack>

Passo 8. Confirmar se o Plugin foi adicionado na Stack​

Execute o comando:

stk-legacy list plugin
info

Templates e Plugins são utilizados para criar uma aplicação (app). Para testá-los, utilize o comando stk-legacy create app e stk-legacy apply plugin informando o caminho da pasta do Template ou Plugin que você deseja testar.

Você pode adicionar os Plugins/Templates criados dessa forma em outras Stacks. Se eles forem alterados, automaticamente as mudanças são refletidas em qualquer um deles, independente da Stack que estiverem.

Confira também​

Esta página foi útil?