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

Aplicar um Plugin


O que é um Plugin?

Extensões de uma Stack que permitem adicionar novas capacidades ao Template base por meio da inclusão de código fonte, importação de bibliotecas e até mesmo a execução de comandos e operações complexas para adicionar capacidades a Stack.

Pré-requisitos

Agora, siga os passos abaixo:

Passo 1. Verificar os Plugins disponíveis

Execute o comando abaixo:

stk-legacy list plugin

Passo 2. Aplicar o Plugin

Escolha os Plugins que você quer usar, e dentro do diretório do seu projeto, execute o comando abaixo:

stk-legacy apply plugin <NOME-DA-STACK/NOME-DO-PLUGIN>
  • Se você aplicar um Plugin que está na Stack que você já criou usando o comando stk-legacy create app, não é necessário colocar o nome da Stack no comando. Caso seja um Plugin de outra Stack, você precisa seguir o padrão do exemplo acima: <NOME-DA-STACK/NOME-DO-PLUGIN>.

O autocomplete está disponível se você estiver usando bash ou zsh.

info

É possível aplicar um Plugin a um projeto criado fora da StackSpot. O STK CLI informa quando o projeto não é da StackSpot, e pede sua autorização para aplicar o Plugin.

Passo 3. Confirmar se o Plugin foi aplicado

Acesse o diretório do seu projeto e execute o comando:

tree -a

Aplicar Plugin no seu projeto existente

Contexto

É possível utilizar um Plugin em um projeto que não tenha sido criado por meio de uma Stack da StackSpot. Estes projetos recebem o nome de projetos legados.

Para você aplicar um Plugin da StackSpot em um dos seus projetos já existentes, siga os passos abaixo:

Requisitos

É necessário importar uma Stack que tenha pelo menos um Plugin disponível para uso.

Passo 1. Aplicar o Plugin no projeto

Execute o comando abaixo:

stk-legacy apply plugin <NOME-DA-STACK/NOME-DO-PLUGIN>

Passo 2. Confirmar o uso

O STK CLI informa os casos em que o projeto não foi criado usando o StackSpot. Depois pede a sua aprovação para você aplicar o Plugin:

~ stk-legacy apply plugin <stack>/<plugin>
? The current folder doesn't seem to be the root of Stack Spot project. Do you still want to proceed applying the plugin? (Y/n)

Passo 3. Inserir inputs

Ao confirmar o uso do Plugin, o STK CLI pede os inputs específicos do Plugin antes de aplicá-lo ao projeto. Assim, cria o arquivo stk.yaml na pasta do seu projeto.

Próximos Passos

Esta página foi útil?