Toshi Ossada for flutterbrasil

Posted on May 1

Publicando seus packages no pub.dev

#packages #pubdev #publishing #flutter

Fala Devs, é muito comum quando vamos desenvolver um app a recorrermos a utilização de packages lá no pub.dev, lá tem packages realmente uteis e aposto que você já teve uma ideia que também iria ajudar alguém, o que alguns talvez não saibam é que todos nós podemos submeter nossos packages para serem utilizados lá, além disso podemos criar nosso projeto orientados a packages onde criamos cada feature de nosso projeto e disponibilizamos por meio de packages para o restante do nosso time. Neste artigo iremos criar um package para ser publicado no pub.dev.

Primeiramente precisamos criar nosso projeto com o flutter create, mas antes de realizarmos o create vamos adicionar o argumento -h para saber o que podemos fazer no flutter create.

Observe que temos o argumento — template= é exatamente este argumento que utilizaremos para gerar o package, em especial temos o tipo package e plugins, basicamente packages são pacotes em código puro em dart e plugins são pacotes que usarão código nativo (kotlin ou swift), no artigo de hoje iremos utilizar o package.

Com isso teremos uma estrutura bem semelhante ao do app em flutter

E se observarmos o pubspec ele também é bem parecido, ele possui algumas informações a mais como nome do package, descrição, versão etc. também podemos adicionar dependências, vamos adicionar o Dio.

Como se trata de um package é muito importante em tomar cuidado de que as dependências que utilizamos não quebre com a versão conforme a versão (e ao mesmo tempo não deixarmos obsoletas) então na versão vamos utilizar a notação >= 3.0.9 < 4.0.0, isso significa que ele ira utilizar o DIO na versão mais recente a partir da 3.0.9 e até a versão 4.0.0, isso porque quando mudar a major version significa que o package teve uma grande break change e provavelmente irá fazer com que meu código quebre.

Vamos também alterar a description, esta informação é a que aparecerá no about do seu package no pub.dev.

Algo bastante importante a se fazer (caso deseje publicar seu package no pub.dev) é criar um projeto de exemplo chamado exemplo dentro do projeto do seu package, mostrando em como você deve utilizar seu package.

Com isso você já pode ir ao pubspec do seu projeto ‘example’ e adicionar referência para seu package

Utilizaremos o nome que está no arquivo principal do seu package

Feito isso vamos voltar ao projeto do nosso package e estruturá-lo da seguinte maneira.

Em nossa model vamos prepará-la para receber o JSON e armazenar o id, o nome do Pokémon e a url da imagem.

Em nosso repository apenas iremos fazer uma requisição ao https://pokeapi.co/api/v2/pokemon/num utilizando o Dio, passando o número como parâmetro, isso me retornara informações do Pokémon

Já no meu controller apenas terei o método que recebera um número e irá chamar meu get() do repository

Enfim, tenho um widget que tem um FutureBuilder que receberá o retorno da função get do controller e irá tratar o retorno para montar uma coluna com a imagem do Pokémon e o nome e o número em cima.

Agora no meu arquivo principal eu preciso exportar meu widget para que meu aplicativo consiga enxergar meu widget (poderia exportar aquilo que eu quiser como os modelos e até mesmo os repositories)

Agora voltamos ao meu app de exemplo para testarmos a implementação do meu package.

No arquivo main.dart vamos importar o widget do meu package

E já na minha HomePage posso chamar meu widget Pokemon() passando o parâmetro num.

Desta forma ao rodarmos o App teremos o seguinte resultado

Pronto! meu package está pronto para uso, caso eu queira deixar meus packages privados para utilização de um projeto interno utilizando a orientação a packages, eu paro por aqui, coloco em um repositório privado da minha empresa e utilizo ele em meu projeto. Mas a intenção do artigo é também mostrar como podemos publicá-los em modo público lá no pub.dev.

Então vamos seguir em frente, é uma boa publicarmos nosso package lá no github em um repositório público. Para isso vamos lá no github, clicamos em New

Depois damos um nome para o repositório e uma descrição

Depois voltamos no terminal aberto la no nosso projeto e primeiramente iniciaremos o git na nossa pasta com git init

Temos que adicionar as alterações no nosso repositório local com git add .

E agora commitar nossas alterações

Em seguida vamos apontar o git para o endereço do nosso github

E finalmente dar um git push para empurrar nossas alterações para o repositório (no caso o github)

Feito isso nosso código estará lá no github

Agora podemos alterar a homepage no pubspec do nosso package para o endereço do github.

Temos também um arquivo de Changelog, lá é onde colocaremos as modificações do package conforme a versão

Ele vai aparecer lá no site do pub.dev na aba changelog

Feito isso é só publicar o package flutter pub publish, mas antes disso vamos ver o -h

Lá temos o argumento –dry-run, este argumento serve para verificar se está tudo certo no seu package e se está sem nenhuma pendência para ser publicado.

Se estiver tudo certo aparecera esta mensagem. Agora sim podemos publicar

Vai pedir para você confirmar

Logo em seguida ele irá pedir para realizar login na sua google account, basta entrar no link e fazer o login

Depois de fazer o login aparecera a mensagem de sucesso

A aparição do seu package no pub.dev não é imediata, leva um tempo ate replicar em todos os servidores, mas se voltar em alguns minutos já irá ver seu package publicado