Skip to content

Latest commit

 

History

History
188 lines (113 loc) · 6.61 KB

README-PT.md

File metadata and controls

188 lines (113 loc) · 6.61 KB

Pub GitHub stars Telegram

Actions Status Actions Status Actions Status Actions Status Actions Status

View the docs in English

Slidy

Um gerenciador de pacotes CLI e gerador de templates para Flutter. Gere Módulos, Páginas, Widgets, BLoCs, Controles e testes. O Slidy suporta os principais gerenciadores de estado, rxBLoC, flutter_bloc e mobx.

Por que usar?

O objetivo do Slidy é ajudá-lo a estruturar seu projeto de maneira padronizada. Organize seu aplicativo em Módulos formados por páginas, repositórios, widgets, BloCs e também crie testes de unidade automaticamente. O módulo oferece uma maneira mais fácil de injetar dependências e blocos, incluindo descarte automático. Também ajuda a instalar as dependências e pacotes, atualizando e removendo-os. O melhor é que você pode fazer tudo isso executando um único comando.

Motivações

Percebemos que a ausência de padrão de projeto está afetando a produtividade da maioria dos desenvolvedores, por isso propomos um padrão de desenvolvimento junto com uma ferramenta que imita a funcionalidade NPM (NodeJS), bem como os recursos de geração de modelo (semelhante ao Scaffold).

Sobre o padrão proposto

A estrutura que o slidy oferece a você é semelhante ao MVC, onde uma página mantém suas próprias business logic classes(BloC).

Recomendamos que você use bloc_pattern ao estruturar com slidy. Ele oferece a estrutura do módulo (estendendo o ModuleWidget) e a injeção de dependência / bloco, ou você provavelmente receberá um erro.

Para entender o pacote bloc_pattern, consulte o README.

Também usamos o Repository Pattern, para que a estrutura da pasta seja organizada em módulos locais e um módulo global. As dependências (repositórios, BloCs, modelos, etc.) podem ser acessadas em todo o aplicativo.

Estrutura de pasta de exemplo gerada por slidy:

Exemplo de pasta

Instalação

  1. Ative o slidy usando o pub:          flutter pub global activate slidy     
  2. Digite slidy --version para certificar que tudo funcionou corretamente. Este comando deve retornar a versão instalada.

Comandos:

upgrade:

Atualiza a versão do slidy:

slidy upgrade

start:

Crie a estrutura básica do seu projeto (verifique se a pasta "lib" está vazia).

slidy start //default
slidy start --flutter_bloc
slidy start --mobx

Se você tiver o pacote flutter_bloc ou flutter_mobx no pubspec, a geração de páginas, widgets e bloco será padronizada para o padrão do gerenciador instalado.

Exemplo de pasta

run:

Executa os scripts em pubspec.yaml:

slidy run open_folder

Exemplo de pasta

install:

Instala ou atualiza os pacotes em dependências:

Exemplo de pasta

install slidy rxdart dio bloc_pattern

ou você pode simplesmente usar o comando i (ambos são iguais)

slidy i rxdart dio bloc_pattern

Instale pacotes como dev_dependency:

slidy i mockito --dev

Exemplo de pasta

uninstall:

Remove um pacote

 slidy uninstall dio

Você também pode remover uma dev_dependency usando o sinalizador --dev

generate:

Cria um módulo, página, widget ou repositório, incluindo sua classe BloC.

NOTA: Você pode substituir "g" pelo comando "generate".

Cria um novo module:

slidy g module nome_da_pasta

Exemplo de pasta

Cria uma nova página + BloC:

slidy g page nome_da_pasta / páginas

Cria um novo widget + BloC:

slidy g widget nome_da_pasta / widgets

NOTA: Você pode criar uma página ou widget usando seu respectivo BLoC usando a bandeira - b

Crie um novo repositório

slidy g r nome_da_pasta/repositórios

Você também pode usar o "repositório" no lugar de "r", mas ele terá a mesma função.

Exemplo de pasta

Testes de unidade:

Gere testes de unidade na pasta de teste para você.

slidy test nome_da_pasta/

Erros comuns:

Windows:

Folder example

Se você recebeu este erro ao tentar executar o pub global enable slidy, precisará definir as variáveis de ambiente manualmente:

Na pesquisa do Windows, escreva: Editar variáveis do sistema

Folder example

Em seguida, clique em 'Variáveis de ambiente

Folder example

Vá para Path

Folder example

Em seguida, clique em Novo e adicione o caminho que apareceu no seu console.

Folder example

Para mais informações, assista a esse vídeo.

Participe do nosso Grupo da Flutterando no Telegram!